leadsnap-test-mcp 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +412 -0
- package/api-promise.d.mts +3 -0
- package/api-promise.d.mts.map +1 -0
- package/api-promise.d.ts +3 -0
- package/api-promise.d.ts.map +1 -0
- package/api-promise.js +6 -0
- package/api-promise.js.map +1 -0
- package/api-promise.mjs +3 -0
- package/api-promise.mjs.map +1 -0
- package/client.d.mts +199 -0
- package/client.d.mts.map +1 -0
- package/client.d.ts +199 -0
- package/client.d.ts.map +1 -0
- package/client.js +488 -0
- package/client.js.map +1 -0
- package/client.mjs +484 -0
- package/client.mjs.map +1 -0
- package/core/api-promise.d.mts +46 -0
- package/core/api-promise.d.mts.map +1 -0
- package/core/api-promise.d.ts +46 -0
- package/core/api-promise.d.ts.map +1 -0
- package/core/api-promise.js +74 -0
- package/core/api-promise.js.map +1 -0
- package/core/api-promise.mjs +70 -0
- package/core/api-promise.mjs.map +1 -0
- package/core/error.d.mts +46 -0
- package/core/error.d.mts.map +1 -0
- package/core/error.d.ts +46 -0
- package/core/error.d.ts.map +1 -0
- package/core/error.js +113 -0
- package/core/error.js.map +1 -0
- package/core/error.mjs +97 -0
- package/core/error.mjs.map +1 -0
- package/core/resource.d.mts +6 -0
- package/core/resource.d.mts.map +1 -0
- package/core/resource.d.ts +6 -0
- package/core/resource.d.ts.map +1 -0
- package/core/resource.js +11 -0
- package/core/resource.js.map +1 -0
- package/core/resource.mjs +7 -0
- package/core/resource.mjs.map +1 -0
- package/core/uploads.d.mts +3 -0
- package/core/uploads.d.mts.map +1 -0
- package/core/uploads.d.ts +3 -0
- package/core/uploads.d.ts.map +1 -0
- package/core/uploads.js +6 -0
- package/core/uploads.js.map +1 -0
- package/core/uploads.mjs +2 -0
- package/core/uploads.mjs.map +1 -0
- package/error.d.mts +3 -0
- package/error.d.mts.map +1 -0
- package/error.d.ts +3 -0
- package/error.d.ts.map +1 -0
- package/error.js +6 -0
- package/error.js.map +1 -0
- package/error.mjs +3 -0
- package/error.mjs.map +1 -0
- package/index.d.mts +6 -0
- package/index.d.mts.map +1 -0
- package/index.d.ts +6 -0
- package/index.d.ts.map +1 -0
- package/index.js +30 -0
- package/index.js.map +1 -0
- package/index.mjs +7 -0
- package/index.mjs.map +1 -0
- package/internal/builtin-types.d.mts +73 -0
- package/internal/builtin-types.d.mts.map +1 -0
- package/internal/builtin-types.d.ts +73 -0
- package/internal/builtin-types.d.ts.map +1 -0
- package/internal/builtin-types.js +4 -0
- package/internal/builtin-types.js.map +1 -0
- package/internal/builtin-types.mjs +3 -0
- package/internal/builtin-types.mjs.map +1 -0
- package/internal/detect-platform.d.mts +15 -0
- package/internal/detect-platform.d.mts.map +1 -0
- package/internal/detect-platform.d.ts +15 -0
- package/internal/detect-platform.d.ts.map +1 -0
- package/internal/detect-platform.js +162 -0
- package/internal/detect-platform.js.map +1 -0
- package/internal/detect-platform.mjs +157 -0
- package/internal/detect-platform.mjs.map +1 -0
- package/internal/errors.d.mts +3 -0
- package/internal/errors.d.mts.map +1 -0
- package/internal/errors.d.ts +3 -0
- package/internal/errors.d.ts.map +1 -0
- package/internal/errors.js +41 -0
- package/internal/errors.js.map +1 -0
- package/internal/errors.mjs +36 -0
- package/internal/errors.mjs.map +1 -0
- package/internal/headers.d.mts +20 -0
- package/internal/headers.d.mts.map +1 -0
- package/internal/headers.d.ts +20 -0
- package/internal/headers.d.ts.map +1 -0
- package/internal/headers.js +79 -0
- package/internal/headers.js.map +1 -0
- package/internal/headers.mjs +74 -0
- package/internal/headers.mjs.map +1 -0
- package/internal/parse.d.mts +12 -0
- package/internal/parse.d.mts.map +1 -0
- package/internal/parse.d.ts +12 -0
- package/internal/parse.d.ts.map +1 -0
- package/internal/parse.js +40 -0
- package/internal/parse.js.map +1 -0
- package/internal/parse.mjs +37 -0
- package/internal/parse.mjs.map +1 -0
- package/internal/request-options.d.mts +75 -0
- package/internal/request-options.d.mts.map +1 -0
- package/internal/request-options.d.ts +75 -0
- package/internal/request-options.d.ts.map +1 -0
- package/internal/request-options.js +14 -0
- package/internal/request-options.js.map +1 -0
- package/internal/request-options.mjs +10 -0
- package/internal/request-options.mjs.map +1 -0
- package/internal/shim-types.d.mts +17 -0
- package/internal/shim-types.d.mts.map +1 -0
- package/internal/shim-types.d.ts +17 -0
- package/internal/shim-types.d.ts.map +1 -0
- package/internal/shim-types.js +4 -0
- package/internal/shim-types.js.map +1 -0
- package/internal/shim-types.mjs +3 -0
- package/internal/shim-types.mjs.map +1 -0
- package/internal/shims.d.mts +26 -0
- package/internal/shims.d.mts.map +1 -0
- package/internal/shims.d.ts +26 -0
- package/internal/shims.d.ts.map +1 -0
- package/internal/shims.js +92 -0
- package/internal/shims.js.map +1 -0
- package/internal/shims.mjs +85 -0
- package/internal/shims.mjs.map +1 -0
- package/internal/to-file.d.mts +45 -0
- package/internal/to-file.d.mts.map +1 -0
- package/internal/to-file.d.ts +45 -0
- package/internal/to-file.d.ts.map +1 -0
- package/internal/to-file.js +91 -0
- package/internal/to-file.js.map +1 -0
- package/internal/to-file.mjs +88 -0
- package/internal/to-file.mjs.map +1 -0
- package/internal/tslib.js +81 -0
- package/internal/tslib.mjs +17 -0
- package/internal/types.d.mts +69 -0
- package/internal/types.d.mts.map +1 -0
- package/internal/types.d.ts +69 -0
- package/internal/types.d.ts.map +1 -0
- package/internal/types.js +4 -0
- package/internal/types.js.map +1 -0
- package/internal/types.mjs +3 -0
- package/internal/types.mjs.map +1 -0
- package/internal/uploads.d.mts +42 -0
- package/internal/uploads.d.mts.map +1 -0
- package/internal/uploads.d.ts +42 -0
- package/internal/uploads.d.ts.map +1 -0
- package/internal/uploads.js +141 -0
- package/internal/uploads.js.map +1 -0
- package/internal/uploads.mjs +131 -0
- package/internal/uploads.mjs.map +1 -0
- package/internal/utils/base64.d.mts +3 -0
- package/internal/utils/base64.d.mts.map +1 -0
- package/internal/utils/base64.d.ts +3 -0
- package/internal/utils/base64.d.ts.map +1 -0
- package/internal/utils/base64.js +38 -0
- package/internal/utils/base64.js.map +1 -0
- package/internal/utils/base64.mjs +33 -0
- package/internal/utils/base64.mjs.map +1 -0
- package/internal/utils/bytes.d.mts +4 -0
- package/internal/utils/bytes.d.mts.map +1 -0
- package/internal/utils/bytes.d.ts +4 -0
- package/internal/utils/bytes.d.ts.map +1 -0
- package/internal/utils/bytes.js +31 -0
- package/internal/utils/bytes.js.map +1 -0
- package/internal/utils/bytes.mjs +26 -0
- package/internal/utils/bytes.mjs.map +1 -0
- package/internal/utils/env.d.mts +9 -0
- package/internal/utils/env.d.mts.map +1 -0
- package/internal/utils/env.d.ts +9 -0
- package/internal/utils/env.d.ts.map +1 -0
- package/internal/utils/env.js +22 -0
- package/internal/utils/env.js.map +1 -0
- package/internal/utils/env.mjs +18 -0
- package/internal/utils/env.mjs.map +1 -0
- package/internal/utils/log.d.mts +37 -0
- package/internal/utils/log.d.mts.map +1 -0
- package/internal/utils/log.d.ts +37 -0
- package/internal/utils/log.d.ts.map +1 -0
- package/internal/utils/log.js +87 -0
- package/internal/utils/log.js.map +1 -0
- package/internal/utils/log.mjs +81 -0
- package/internal/utils/log.mjs.map +1 -0
- package/internal/utils/path.d.mts +15 -0
- package/internal/utils/path.d.mts.map +1 -0
- package/internal/utils/path.d.ts +15 -0
- package/internal/utils/path.d.ts.map +1 -0
- package/internal/utils/path.js +79 -0
- package/internal/utils/path.js.map +1 -0
- package/internal/utils/path.mjs +74 -0
- package/internal/utils/path.mjs.map +1 -0
- package/internal/utils/query.d.mts +5 -0
- package/internal/utils/query.d.mts.map +1 -0
- package/internal/utils/query.d.ts +5 -0
- package/internal/utils/query.d.ts.map +1 -0
- package/internal/utils/query.js +23 -0
- package/internal/utils/query.js.map +1 -0
- package/internal/utils/query.mjs +20 -0
- package/internal/utils/query.mjs.map +1 -0
- package/internal/utils/sleep.d.mts +2 -0
- package/internal/utils/sleep.d.mts.map +1 -0
- package/internal/utils/sleep.d.ts +2 -0
- package/internal/utils/sleep.d.ts.map +1 -0
- package/internal/utils/sleep.js +7 -0
- package/internal/utils/sleep.js.map +1 -0
- package/internal/utils/sleep.mjs +3 -0
- package/internal/utils/sleep.mjs.map +1 -0
- package/internal/utils/uuid.d.mts +5 -0
- package/internal/utils/uuid.d.mts.map +1 -0
- package/internal/utils/uuid.d.ts +5 -0
- package/internal/utils/uuid.d.ts.map +1 -0
- package/internal/utils/uuid.js +19 -0
- package/internal/utils/uuid.js.map +1 -0
- package/internal/utils/uuid.mjs +15 -0
- package/internal/utils/uuid.mjs.map +1 -0
- package/internal/utils/values.d.mts +18 -0
- package/internal/utils/values.d.mts.map +1 -0
- package/internal/utils/values.d.ts +18 -0
- package/internal/utils/values.d.ts.map +1 -0
- package/internal/utils/values.js +112 -0
- package/internal/utils/values.js.map +1 -0
- package/internal/utils/values.mjs +94 -0
- package/internal/utils/values.mjs.map +1 -0
- package/internal/utils.d.mts +8 -0
- package/internal/utils.d.mts.map +1 -0
- package/internal/utils.d.ts +8 -0
- package/internal/utils.d.ts.map +1 -0
- package/internal/utils.js +12 -0
- package/internal/utils.js.map +1 -0
- package/internal/utils.mjs +9 -0
- package/internal/utils.mjs.map +1 -0
- package/package.json +143 -0
- package/resource.d.mts +3 -0
- package/resource.d.mts.map +1 -0
- package/resource.d.ts +3 -0
- package/resource.d.ts.map +1 -0
- package/resource.js +6 -0
- package/resource.js.map +1 -0
- package/resource.mjs +3 -0
- package/resource.mjs.map +1 -0
- package/resources/index.d.mts +2 -0
- package/resources/index.d.mts.map +1 -0
- package/resources/index.d.ts +2 -0
- package/resources/index.d.ts.map +1 -0
- package/resources/index.js +7 -0
- package/resources/index.js.map +1 -0
- package/resources/index.mjs +3 -0
- package/resources/index.mjs.map +1 -0
- package/resources/public/api/api.d.mts +10 -0
- package/resources/public/api/api.d.mts.map +1 -0
- package/resources/public/api/api.d.ts +10 -0
- package/resources/public/api/api.d.ts.map +1 -0
- package/resources/public/api/api.js +17 -0
- package/resources/public/api/api.js.map +1 -0
- package/resources/public/api/api.mjs +12 -0
- package/resources/public/api/api.mjs.map +1 -0
- package/resources/public/api/index.d.mts +3 -0
- package/resources/public/api/index.d.mts.map +1 -0
- package/resources/public/api/index.d.ts +3 -0
- package/resources/public/api/index.d.ts.map +1 -0
- package/resources/public/api/index.js +9 -0
- package/resources/public/api/index.js.map +1 -0
- package/resources/public/api/index.mjs +4 -0
- package/resources/public/api/index.mjs.map +1 -0
- package/resources/public/api/v1/heatmap/heatmap.d.mts +724 -0
- package/resources/public/api/v1/heatmap/heatmap.d.mts.map +1 -0
- package/resources/public/api/v1/heatmap/heatmap.d.ts +724 -0
- package/resources/public/api/v1/heatmap/heatmap.d.ts.map +1 -0
- package/resources/public/api/v1/heatmap/heatmap.js +163 -0
- package/resources/public/api/v1/heatmap/heatmap.js.map +1 -0
- package/resources/public/api/v1/heatmap/heatmap.mjs +158 -0
- package/resources/public/api/v1/heatmap/heatmap.mjs.map +1 -0
- package/resources/public/api/v1/heatmap/index.d.mts +3 -0
- package/resources/public/api/v1/heatmap/index.d.mts.map +1 -0
- package/resources/public/api/v1/heatmap/index.d.ts +3 -0
- package/resources/public/api/v1/heatmap/index.d.ts.map +1 -0
- package/resources/public/api/v1/heatmap/index.js +9 -0
- package/resources/public/api/v1/heatmap/index.js.map +1 -0
- package/resources/public/api/v1/heatmap/index.mjs +4 -0
- package/resources/public/api/v1/heatmap/index.mjs.map +1 -0
- package/resources/public/api/v1/heatmap/schedules.d.mts +775 -0
- package/resources/public/api/v1/heatmap/schedules.d.mts.map +1 -0
- package/resources/public/api/v1/heatmap/schedules.d.ts +775 -0
- package/resources/public/api/v1/heatmap/schedules.d.ts.map +1 -0
- package/resources/public/api/v1/heatmap/schedules.js +146 -0
- package/resources/public/api/v1/heatmap/schedules.js.map +1 -0
- package/resources/public/api/v1/heatmap/schedules.mjs +142 -0
- package/resources/public/api/v1/heatmap/schedules.mjs.map +1 -0
- package/resources/public/api/v1/heatmap.d.mts +2 -0
- package/resources/public/api/v1/heatmap.d.mts.map +1 -0
- package/resources/public/api/v1/heatmap.d.ts +2 -0
- package/resources/public/api/v1/heatmap.d.ts.map +1 -0
- package/resources/public/api/v1/heatmap.js +6 -0
- package/resources/public/api/v1/heatmap.js.map +1 -0
- package/resources/public/api/v1/heatmap.mjs +3 -0
- package/resources/public/api/v1/heatmap.mjs.map +1 -0
- package/resources/public/api/v1/index.d.mts +3 -0
- package/resources/public/api/v1/index.d.mts.map +1 -0
- package/resources/public/api/v1/index.d.ts +3 -0
- package/resources/public/api/v1/index.d.ts.map +1 -0
- package/resources/public/api/v1/index.js +9 -0
- package/resources/public/api/v1/index.js.map +1 -0
- package/resources/public/api/v1/index.mjs +4 -0
- package/resources/public/api/v1/index.mjs.map +1 -0
- package/resources/public/api/v1/v1.d.mts +10 -0
- package/resources/public/api/v1/v1.d.mts.map +1 -0
- package/resources/public/api/v1/v1.d.ts +10 -0
- package/resources/public/api/v1/v1.d.ts.map +1 -0
- package/resources/public/api/v1/v1.js +17 -0
- package/resources/public/api/v1/v1.js.map +1 -0
- package/resources/public/api/v1/v1.mjs +12 -0
- package/resources/public/api/v1/v1.mjs.map +1 -0
- package/resources/public/api/v1.d.mts +2 -0
- package/resources/public/api/v1.d.mts.map +1 -0
- package/resources/public/api/v1.d.ts +2 -0
- package/resources/public/api/v1.d.ts.map +1 -0
- package/resources/public/api/v1.js +6 -0
- package/resources/public/api/v1.js.map +1 -0
- package/resources/public/api/v1.mjs +3 -0
- package/resources/public/api/v1.mjs.map +1 -0
- package/resources/public/api.d.mts +2 -0
- package/resources/public/api.d.mts.map +1 -0
- package/resources/public/api.d.ts +2 -0
- package/resources/public/api.d.ts.map +1 -0
- package/resources/public/api.js +6 -0
- package/resources/public/api.js.map +1 -0
- package/resources/public/api.mjs +3 -0
- package/resources/public/api.mjs.map +1 -0
- package/resources/public/index.d.mts +3 -0
- package/resources/public/index.d.mts.map +1 -0
- package/resources/public/index.d.ts +3 -0
- package/resources/public/index.d.ts.map +1 -0
- package/resources/public/index.js +9 -0
- package/resources/public/index.js.map +1 -0
- package/resources/public/index.mjs +4 -0
- package/resources/public/index.mjs.map +1 -0
- package/resources/public/public.d.mts +10 -0
- package/resources/public/public.d.mts.map +1 -0
- package/resources/public/public.d.ts +10 -0
- package/resources/public/public.d.ts.map +1 -0
- package/resources/public/public.js +17 -0
- package/resources/public/public.js.map +1 -0
- package/resources/public/public.mjs +12 -0
- package/resources/public/public.mjs.map +1 -0
- package/resources/public.d.mts +2 -0
- package/resources/public.d.mts.map +1 -0
- package/resources/public.d.ts +2 -0
- package/resources/public.d.ts.map +1 -0
- package/resources/public.js +6 -0
- package/resources/public.js.map +1 -0
- package/resources/public.mjs +3 -0
- package/resources/public.mjs.map +1 -0
- package/resources.d.mts +2 -0
- package/resources.d.mts.map +1 -0
- package/resources.d.ts +2 -0
- package/resources.d.ts.map +1 -0
- package/resources.js +5 -0
- package/resources.js.map +1 -0
- package/resources.mjs +2 -0
- package/resources.mjs.map +1 -0
- package/src/api-promise.ts +2 -0
- package/src/client.ts +770 -0
- package/src/core/README.md +3 -0
- package/src/core/api-promise.ts +92 -0
- package/src/core/error.ts +130 -0
- package/src/core/resource.ts +11 -0
- package/src/core/uploads.ts +2 -0
- package/src/error.ts +2 -0
- package/src/index.ts +22 -0
- package/src/internal/README.md +3 -0
- package/src/internal/builtin-types.ts +93 -0
- package/src/internal/detect-platform.ts +196 -0
- package/src/internal/errors.ts +33 -0
- package/src/internal/headers.ts +97 -0
- package/src/internal/parse.ts +56 -0
- package/src/internal/request-options.ts +91 -0
- package/src/internal/shim-types.ts +26 -0
- package/src/internal/shims.ts +107 -0
- package/src/internal/to-file.ts +154 -0
- package/src/internal/types.ts +93 -0
- package/src/internal/uploads.ts +187 -0
- package/src/internal/utils/base64.ts +40 -0
- package/src/internal/utils/bytes.ts +32 -0
- package/src/internal/utils/env.ts +18 -0
- package/src/internal/utils/log.ts +128 -0
- package/src/internal/utils/path.ts +88 -0
- package/src/internal/utils/query.ts +23 -0
- package/src/internal/utils/sleep.ts +3 -0
- package/src/internal/utils/uuid.ts +17 -0
- package/src/internal/utils/values.ts +105 -0
- package/src/internal/utils.ts +9 -0
- package/src/lib/.keep +4 -0
- package/src/resource.ts +2 -0
- package/src/resources/index.ts +3 -0
- package/src/resources/public/api/api.ts +15 -0
- package/src/resources/public/api/index.ts +4 -0
- package/src/resources/public/api/v1/heatmap/heatmap.ts +1165 -0
- package/src/resources/public/api/v1/heatmap/index.ts +29 -0
- package/src/resources/public/api/v1/heatmap/schedules.ts +1189 -0
- package/src/resources/public/api/v1/heatmap.ts +3 -0
- package/src/resources/public/api/v1/index.ts +18 -0
- package/src/resources/public/api/v1/v1.ts +43 -0
- package/src/resources/public/api/v1.ts +3 -0
- package/src/resources/public/api.ts +3 -0
- package/src/resources/public/index.ts +4 -0
- package/src/resources/public/public.ts +15 -0
- package/src/resources/public.ts +3 -0
- package/src/resources.ts +1 -0
- package/src/tsconfig.json +11 -0
- package/src/uploads.ts +2 -0
- package/src/version.ts +1 -0
- package/uploads.d.mts +3 -0
- package/uploads.d.mts.map +1 -0
- package/uploads.d.ts +3 -0
- package/uploads.d.ts.map +1 -0
- package/uploads.js +6 -0
- package/uploads.js.map +1 -0
- package/uploads.mjs +3 -0
- package/uploads.mjs.map +1 -0
- package/version.d.mts +2 -0
- package/version.d.mts.map +1 -0
- package/version.d.ts +2 -0
- package/version.d.ts.map +1 -0
- package/version.js +5 -0
- package/version.js.map +1 -0
- package/version.mjs +2 -0
- package/version.mjs.map +1 -0
|
@@ -0,0 +1,724 @@
|
|
|
1
|
+
import { APIResource } from "../../../../../core/resource.mjs";
|
|
2
|
+
import * as SchedulesAPI from "./schedules.mjs";
|
|
3
|
+
import { ScheduleCreateScheduleParams, ScheduleCreateScheduleResponse, ScheduleListSchedulesParams, ScheduleListSchedulesResponse, SchedulePauseScheduleResponse, ScheduleResumeScheduleResponse, ScheduleRetrieveScheduleResponse, ScheduleUpdateScheduleParams, ScheduleUpdateScheduleResponse, Schedules } from "./schedules.mjs";
|
|
4
|
+
import { APIPromise } from "../../../../../core/api-promise.mjs";
|
|
5
|
+
import { RequestOptions } from "../../../../../internal/request-options.mjs";
|
|
6
|
+
export declare class Heatmap extends APIResource {
|
|
7
|
+
schedules: SchedulesAPI.Schedules;
|
|
8
|
+
/**
|
|
9
|
+
* Returns the computed grid point coordinates for a given configuration without
|
|
10
|
+
* creating a heatmap. Use this to preview a grid layout or to obtain the `points`
|
|
11
|
+
* array that can be passed to the Create Heatmap or Create Schedule endpoints.
|
|
12
|
+
*
|
|
13
|
+
* `grid_radius` is the spacing between points and is **always in meters** — e.g.
|
|
14
|
+
* `1000` = 1 km, `1609` ≈ 1 mile. When `polygon` is supplied the grid is clipped
|
|
15
|
+
* to that shape and only points inside it are returned.
|
|
16
|
+
*
|
|
17
|
+
* @example
|
|
18
|
+
* ```ts
|
|
19
|
+
* const response =
|
|
20
|
+
* await client.public.api.v1.heatmap.generateGridPoints({
|
|
21
|
+
* grid_radius: 3495,
|
|
22
|
+
* grid_size: 3,
|
|
23
|
+
* lat: 44.670381143996,
|
|
24
|
+
* lng: -88.122418774951,
|
|
25
|
+
* });
|
|
26
|
+
* ```
|
|
27
|
+
*/
|
|
28
|
+
generateGridPoints(body: HeatmapGenerateGridPointsParams, options?: RequestOptions): APIPromise<HeatmapGenerateGridPointsResponse>;
|
|
29
|
+
/**
|
|
30
|
+
* Returns details for a single grid point within a heatmap, including its
|
|
31
|
+
* coordinates, rank, and surrounding place rankings.
|
|
32
|
+
*
|
|
33
|
+
* @example
|
|
34
|
+
* ```ts
|
|
35
|
+
* const response =
|
|
36
|
+
* await client.public.api.v1.heatmap.retrieveHeatmapPoint(
|
|
37
|
+
* 1,
|
|
38
|
+
* { heatmap_id: 1 },
|
|
39
|
+
* );
|
|
40
|
+
* ```
|
|
41
|
+
*/
|
|
42
|
+
retrieveHeatmapPoint(pointID: number, params: HeatmapRetrieveHeatmapPointParams, options?: RequestOptions): APIPromise<HeatmapRetrieveHeatmapPointResponse>;
|
|
43
|
+
/**
|
|
44
|
+
* Returns a paginated list of heatmaps for the authenticated account. Supports
|
|
45
|
+
* filtering, sorting, searching, and pagination.
|
|
46
|
+
*
|
|
47
|
+
* **Pagination** — all list responses include pagination fields at the root level
|
|
48
|
+
* alongside `data`:
|
|
49
|
+
*
|
|
50
|
+
* - `total` total matching records; `last_page` total pages; `per_page` results
|
|
51
|
+
* per page (default 25)
|
|
52
|
+
* - `next_page_url` URL of the next page (`null` on the last page)
|
|
53
|
+
* - `links` array of page link objects (`url`, `label`, `active`)
|
|
54
|
+
*
|
|
55
|
+
* **Date filters** — `filter[created_at]` accepts an object with `start_date`
|
|
56
|
+
* and/or `end_date` (YYYY-MM-DD):
|
|
57
|
+
*
|
|
58
|
+
* ```
|
|
59
|
+
* filter[created_at][start_date]=2026-01-01
|
|
60
|
+
* filter[created_at][end_date]=2026-04-30
|
|
61
|
+
* ```
|
|
62
|
+
*
|
|
63
|
+
* Alternatively, pass a named range alias via `filter[created_at][date]`: `today`,
|
|
64
|
+
* `yesterday`, `this_week`, `last_week`, `last_7_days`, `last_30_days`,
|
|
65
|
+
* `last_90_days`, `this_month`, `last_month`, `this_quarter`, `last_quarter`,
|
|
66
|
+
* `this_year`, `year_to_date`, `last_year`, `all_time`
|
|
67
|
+
*
|
|
68
|
+
* @example
|
|
69
|
+
* ```ts
|
|
70
|
+
* const response =
|
|
71
|
+
* await client.public.api.v1.heatmap.listHeatmaps();
|
|
72
|
+
* ```
|
|
73
|
+
*/
|
|
74
|
+
listHeatmaps(query?: HeatmapListHeatmapsParams | null | undefined, options?: RequestOptions): APIPromise<HeatmapListHeatmapsResponse>;
|
|
75
|
+
/**
|
|
76
|
+
* Creates one or more heatmaps. Each combination of keyword × search_type
|
|
77
|
+
* generates a separate heatmap.
|
|
78
|
+
*
|
|
79
|
+
* @example
|
|
80
|
+
* ```ts
|
|
81
|
+
* const response =
|
|
82
|
+
* await client.public.api.v1.heatmap.createHeatmap({
|
|
83
|
+
* distanceType: 'm',
|
|
84
|
+
* grid_radius: 3495,
|
|
85
|
+
* grid_size: 3,
|
|
86
|
+
* keyword: ['roofing'],
|
|
87
|
+
* lat: 44.670381143996,
|
|
88
|
+
* lng: -88.122418774951,
|
|
89
|
+
* place_id: 'ChIJFzfDtmDzAogRn0zn9LJaP_A',
|
|
90
|
+
* search_type: ['google_maps'],
|
|
91
|
+
* });
|
|
92
|
+
* ```
|
|
93
|
+
*/
|
|
94
|
+
createHeatmap(body: HeatmapCreateHeatmapParams, options?: RequestOptions): APIPromise<HeatmapCreateHeatmapResponse>;
|
|
95
|
+
/**
|
|
96
|
+
* Returns a paginated list of Google Business Profile locations for the
|
|
97
|
+
* authenticated account. Supports filtering, sorting, searching, and pagination.
|
|
98
|
+
*
|
|
99
|
+
* **Pagination** — all list responses include pagination fields at the root level
|
|
100
|
+
* alongside `data`:
|
|
101
|
+
*
|
|
102
|
+
* - `total` total matching records; `last_page` total pages; `per_page` results
|
|
103
|
+
* per page (default 25)
|
|
104
|
+
* - `next_page_url` URL of the next page (`null` on the last page)
|
|
105
|
+
* - `links` array of page link objects (`url`, `label`, `active`)
|
|
106
|
+
*
|
|
107
|
+
* @example
|
|
108
|
+
* ```ts
|
|
109
|
+
* const response =
|
|
110
|
+
* await client.public.api.v1.heatmap.listLocations();
|
|
111
|
+
* ```
|
|
112
|
+
*/
|
|
113
|
+
listLocations(query?: HeatmapListLocationsParams | null | undefined, options?: RequestOptions): APIPromise<HeatmapListLocationsResponse>;
|
|
114
|
+
/**
|
|
115
|
+
* Returns full details of a single heatmap including grid points, place info, and
|
|
116
|
+
* ranking statistics.
|
|
117
|
+
*
|
|
118
|
+
* @example
|
|
119
|
+
* ```ts
|
|
120
|
+
* const response =
|
|
121
|
+
* await client.public.api.v1.heatmap.retrieveHeatmap(1482);
|
|
122
|
+
* ```
|
|
123
|
+
*/
|
|
124
|
+
retrieveHeatmap(heatmap: number, options?: RequestOptions): APIPromise<HeatmapRetrieveHeatmapResponse>;
|
|
125
|
+
/**
|
|
126
|
+
* Returns aggregated ranking statistics for all competitor businesses found across
|
|
127
|
+
* the grid points of the specified heatmap.
|
|
128
|
+
*
|
|
129
|
+
* @example
|
|
130
|
+
* ```ts
|
|
131
|
+
* const response =
|
|
132
|
+
* await client.public.api.v1.heatmap.retrieveHeatmapCompetitors(
|
|
133
|
+
* 1482,
|
|
134
|
+
* );
|
|
135
|
+
* ```
|
|
136
|
+
*/
|
|
137
|
+
retrieveHeatmapCompetitors(heatmap: number, options?: RequestOptions): APIPromise<HeatmapRetrieveHeatmapCompetitorsResponse>;
|
|
138
|
+
}
|
|
139
|
+
export interface HeatmapCreateHeatmapResponse {
|
|
140
|
+
id?: number;
|
|
141
|
+
area?: string | null;
|
|
142
|
+
ave_review_rating?: string | null;
|
|
143
|
+
average?: string | null;
|
|
144
|
+
average_position?: string | null;
|
|
145
|
+
business_name?: string;
|
|
146
|
+
business_place_id?: string;
|
|
147
|
+
created_at?: string;
|
|
148
|
+
grid_center_lat?: number;
|
|
149
|
+
grid_center_lng?: number;
|
|
150
|
+
grid_distance_measure?: string;
|
|
151
|
+
grid_point_distance?: string;
|
|
152
|
+
grid_point_distance_row?: number;
|
|
153
|
+
grid_size?: number;
|
|
154
|
+
keyword?: string;
|
|
155
|
+
keyword_difficulty?: string | null;
|
|
156
|
+
keyword_search_intents?: Array<unknown>;
|
|
157
|
+
lead_source_id?: string | null;
|
|
158
|
+
location?: string | null;
|
|
159
|
+
location_id?: string | null;
|
|
160
|
+
market_share?: string | null;
|
|
161
|
+
market_share_position?: string | null;
|
|
162
|
+
place?: string | null;
|
|
163
|
+
place_id?: string;
|
|
164
|
+
points?: Array<unknown>;
|
|
165
|
+
previous_ranking?: string | null;
|
|
166
|
+
ranking_change?: string | null;
|
|
167
|
+
ranking_change_percentage?: string | null;
|
|
168
|
+
review_count?: string | null;
|
|
169
|
+
search_type?: string;
|
|
170
|
+
search_volume?: string | null;
|
|
171
|
+
status?: string;
|
|
172
|
+
tags?: Array<unknown>;
|
|
173
|
+
top_3_percentage?: string | null;
|
|
174
|
+
top_3_points?: number;
|
|
175
|
+
top_3_position?: string | null;
|
|
176
|
+
top_n?: string | null;
|
|
177
|
+
total?: number;
|
|
178
|
+
total_points?: number;
|
|
179
|
+
updated_at?: string;
|
|
180
|
+
zoom_level?: string | null;
|
|
181
|
+
}
|
|
182
|
+
export interface HeatmapGenerateGridPointsResponse {
|
|
183
|
+
count?: number;
|
|
184
|
+
points?: Array<HeatmapGenerateGridPointsResponse.Point>;
|
|
185
|
+
}
|
|
186
|
+
export declare namespace HeatmapGenerateGridPointsResponse {
|
|
187
|
+
interface Point {
|
|
188
|
+
lat?: number;
|
|
189
|
+
lng?: number;
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
export interface HeatmapListHeatmapsResponse {
|
|
193
|
+
current_page?: number;
|
|
194
|
+
data?: Array<HeatmapListHeatmapsResponse.Data>;
|
|
195
|
+
first_page_url?: string;
|
|
196
|
+
from?: number;
|
|
197
|
+
last_page?: number;
|
|
198
|
+
last_page_url?: string;
|
|
199
|
+
links?: Array<unknown>;
|
|
200
|
+
next_page_url?: string;
|
|
201
|
+
path?: string;
|
|
202
|
+
per_page?: number;
|
|
203
|
+
prev_page_url?: string | null;
|
|
204
|
+
to?: number;
|
|
205
|
+
total?: number;
|
|
206
|
+
}
|
|
207
|
+
export declare namespace HeatmapListHeatmapsResponse {
|
|
208
|
+
interface Data {
|
|
209
|
+
id?: number;
|
|
210
|
+
area?: string;
|
|
211
|
+
ave_review_rating?: string | null;
|
|
212
|
+
average?: string | null;
|
|
213
|
+
average_position?: string | null;
|
|
214
|
+
business_name?: string;
|
|
215
|
+
business_place_id?: string;
|
|
216
|
+
created_at?: string;
|
|
217
|
+
grid_center_lat?: number;
|
|
218
|
+
grid_center_lng?: number;
|
|
219
|
+
grid_distance_measure?: string;
|
|
220
|
+
grid_point_distance?: string;
|
|
221
|
+
grid_point_distance_row?: number;
|
|
222
|
+
grid_size?: number;
|
|
223
|
+
keyword?: string;
|
|
224
|
+
lead_source_id?: string | null;
|
|
225
|
+
location?: string | null;
|
|
226
|
+
location_id?: string | null;
|
|
227
|
+
market_share?: string | null;
|
|
228
|
+
market_share_position?: string | null;
|
|
229
|
+
place?: Data.Place;
|
|
230
|
+
place_id?: number;
|
|
231
|
+
previous_ranking?: string | null;
|
|
232
|
+
ranking_change?: string | null;
|
|
233
|
+
ranking_change_percentage?: string | null;
|
|
234
|
+
review_count?: string | null;
|
|
235
|
+
search_type?: string;
|
|
236
|
+
status?: string;
|
|
237
|
+
status_code?: number;
|
|
238
|
+
top_3_percentage?: string | null;
|
|
239
|
+
top_3_points?: string | null;
|
|
240
|
+
top_3_position?: string | null;
|
|
241
|
+
top_n?: string | null;
|
|
242
|
+
total?: string | null;
|
|
243
|
+
total_points?: string | null;
|
|
244
|
+
updated_at?: string;
|
|
245
|
+
zoom_level?: string;
|
|
246
|
+
}
|
|
247
|
+
namespace Data {
|
|
248
|
+
interface Place {
|
|
249
|
+
id?: number;
|
|
250
|
+
address?: string;
|
|
251
|
+
ave_review_rating?: number;
|
|
252
|
+
feature_id?: string | null;
|
|
253
|
+
google_place_id?: string;
|
|
254
|
+
google_place_serial?: string;
|
|
255
|
+
latitude?: string;
|
|
256
|
+
longitude?: string;
|
|
257
|
+
main_category?: string;
|
|
258
|
+
map_url?: string;
|
|
259
|
+
name?: string;
|
|
260
|
+
phone?: string;
|
|
261
|
+
place_url?: string;
|
|
262
|
+
ranking?: string | null;
|
|
263
|
+
related_categories?: Array<string>;
|
|
264
|
+
review_count?: number;
|
|
265
|
+
thumbnail_url?: string;
|
|
266
|
+
website_url?: string;
|
|
267
|
+
}
|
|
268
|
+
}
|
|
269
|
+
}
|
|
270
|
+
export interface HeatmapListLocationsResponse {
|
|
271
|
+
current_page?: number;
|
|
272
|
+
data?: Array<HeatmapListLocationsResponse.Data>;
|
|
273
|
+
first_page_url?: string;
|
|
274
|
+
from?: number;
|
|
275
|
+
last_page?: number;
|
|
276
|
+
last_page_url?: string;
|
|
277
|
+
links?: Array<unknown>;
|
|
278
|
+
next_page_url?: string;
|
|
279
|
+
path?: string;
|
|
280
|
+
per_page?: number;
|
|
281
|
+
prev_page_url?: string | null;
|
|
282
|
+
to?: number;
|
|
283
|
+
total?: number;
|
|
284
|
+
}
|
|
285
|
+
export declare namespace HeatmapListLocationsResponse {
|
|
286
|
+
interface Data {
|
|
287
|
+
id?: number;
|
|
288
|
+
address?: string;
|
|
289
|
+
ave_review_rating?: number;
|
|
290
|
+
citation?: string | null;
|
|
291
|
+
city?: string;
|
|
292
|
+
completion_percentage?: number;
|
|
293
|
+
country?: string;
|
|
294
|
+
created_at?: string;
|
|
295
|
+
currency?: string;
|
|
296
|
+
deleted_at?: string | null;
|
|
297
|
+
description?: string;
|
|
298
|
+
email?: string | null;
|
|
299
|
+
image?: string;
|
|
300
|
+
is_authorized?: string | null;
|
|
301
|
+
is_citation_subscribed?: boolean;
|
|
302
|
+
is_connected?: number;
|
|
303
|
+
is_gmb_activate?: number;
|
|
304
|
+
last_review_date?: string;
|
|
305
|
+
latitude?: number;
|
|
306
|
+
location_id?: string;
|
|
307
|
+
location_image?: string;
|
|
308
|
+
location_name?: string;
|
|
309
|
+
location_name_initials?: string;
|
|
310
|
+
location_state?: string;
|
|
311
|
+
lock_changes?: number;
|
|
312
|
+
longitude?: number;
|
|
313
|
+
map_url?: string;
|
|
314
|
+
media_count?: number;
|
|
315
|
+
name?: string;
|
|
316
|
+
place_id?: string;
|
|
317
|
+
primary_category?: string;
|
|
318
|
+
primary_phone?: string;
|
|
319
|
+
review_count?: number;
|
|
320
|
+
review_link?: string;
|
|
321
|
+
review_url?: string;
|
|
322
|
+
state?: string;
|
|
323
|
+
status?: string;
|
|
324
|
+
subscription_id?: number;
|
|
325
|
+
subscription_item_id?: number;
|
|
326
|
+
unreplied_review_count?: number;
|
|
327
|
+
updated_at?: string;
|
|
328
|
+
website_url?: string;
|
|
329
|
+
zip?: string;
|
|
330
|
+
zip_code?: string;
|
|
331
|
+
}
|
|
332
|
+
}
|
|
333
|
+
export interface HeatmapRetrieveHeatmapResponse {
|
|
334
|
+
id?: number;
|
|
335
|
+
area?: string;
|
|
336
|
+
ave_review_rating?: number;
|
|
337
|
+
average?: string;
|
|
338
|
+
average_position?: number;
|
|
339
|
+
business_name?: string;
|
|
340
|
+
business_place_id?: string;
|
|
341
|
+
created_at?: string;
|
|
342
|
+
grid_center_lat?: number;
|
|
343
|
+
grid_center_lng?: number;
|
|
344
|
+
grid_distance_measure?: string;
|
|
345
|
+
grid_point_distance?: string;
|
|
346
|
+
grid_point_distance_row?: number;
|
|
347
|
+
grid_size?: number;
|
|
348
|
+
keyword?: string;
|
|
349
|
+
keyword_seo_data?: HeatmapRetrieveHeatmapResponse.KeywordSeoData;
|
|
350
|
+
lead_source_id?: string | null;
|
|
351
|
+
location?: string | null;
|
|
352
|
+
location_id?: string | null;
|
|
353
|
+
market_share?: string;
|
|
354
|
+
market_share_position?: number;
|
|
355
|
+
place?: HeatmapRetrieveHeatmapResponse.Place;
|
|
356
|
+
place_id?: number;
|
|
357
|
+
points?: Array<HeatmapRetrieveHeatmapResponse.Point>;
|
|
358
|
+
previous_ranking?: string | null;
|
|
359
|
+
ranking_change?: string | null;
|
|
360
|
+
ranking_change_percentage?: string | null;
|
|
361
|
+
review_count?: number;
|
|
362
|
+
search_type?: string;
|
|
363
|
+
status?: string;
|
|
364
|
+
status_code?: number;
|
|
365
|
+
tags?: Array<unknown>;
|
|
366
|
+
top_3_percentage?: number;
|
|
367
|
+
top_3_points?: number;
|
|
368
|
+
top_3_position?: number;
|
|
369
|
+
top_n?: number;
|
|
370
|
+
total?: number;
|
|
371
|
+
total_points?: number;
|
|
372
|
+
updated_at?: string;
|
|
373
|
+
zoom_level?: string;
|
|
374
|
+
}
|
|
375
|
+
export declare namespace HeatmapRetrieveHeatmapResponse {
|
|
376
|
+
interface KeywordSeoData {
|
|
377
|
+
id?: number;
|
|
378
|
+
account_id?: number;
|
|
379
|
+
created_at?: string;
|
|
380
|
+
heatmap_keyword_list_id?: number;
|
|
381
|
+
keyword?: string;
|
|
382
|
+
keyword_difficulty?: KeywordSeoData.KeywordDifficulty;
|
|
383
|
+
keyword_search_intents?: Array<KeywordSeoData.KeywordSearchIntent>;
|
|
384
|
+
search_volume?: KeywordSeoData.SearchVolume;
|
|
385
|
+
updated_at?: string;
|
|
386
|
+
}
|
|
387
|
+
namespace KeywordSeoData {
|
|
388
|
+
interface KeywordDifficulty {
|
|
389
|
+
id?: number;
|
|
390
|
+
created_at?: string;
|
|
391
|
+
difficulty?: number;
|
|
392
|
+
keyword?: string;
|
|
393
|
+
language_code?: string;
|
|
394
|
+
location_code?: string;
|
|
395
|
+
updated_at?: string;
|
|
396
|
+
}
|
|
397
|
+
interface KeywordSearchIntent {
|
|
398
|
+
id?: number;
|
|
399
|
+
created_at?: string;
|
|
400
|
+
keyword?: string;
|
|
401
|
+
label?: string;
|
|
402
|
+
language_code?: string;
|
|
403
|
+
probability?: number;
|
|
404
|
+
updated_at?: string;
|
|
405
|
+
}
|
|
406
|
+
interface SearchVolume {
|
|
407
|
+
id?: number;
|
|
408
|
+
competition?: string;
|
|
409
|
+
competition_index?: number;
|
|
410
|
+
cpc?: string;
|
|
411
|
+
created_at?: string;
|
|
412
|
+
high_top_of_page_bid?: string;
|
|
413
|
+
keyword?: string;
|
|
414
|
+
language_code?: string;
|
|
415
|
+
location_code?: string;
|
|
416
|
+
low_top_of_page_bid?: string;
|
|
417
|
+
search_volume?: number;
|
|
418
|
+
updated_at?: string;
|
|
419
|
+
}
|
|
420
|
+
}
|
|
421
|
+
interface Place {
|
|
422
|
+
id?: number;
|
|
423
|
+
address?: string;
|
|
424
|
+
ave_review_rating?: number;
|
|
425
|
+
feature_id?: string;
|
|
426
|
+
google_place_id?: string;
|
|
427
|
+
google_place_serial?: string;
|
|
428
|
+
latitude?: string;
|
|
429
|
+
longitude?: string;
|
|
430
|
+
main_category?: string;
|
|
431
|
+
map_url?: string;
|
|
432
|
+
name?: string;
|
|
433
|
+
phone?: string;
|
|
434
|
+
place_url?: string;
|
|
435
|
+
ranking?: string | null;
|
|
436
|
+
related_categories?: Array<string>;
|
|
437
|
+
review_count?: number;
|
|
438
|
+
thumbnail_url?: string;
|
|
439
|
+
website_url?: string;
|
|
440
|
+
}
|
|
441
|
+
interface Point {
|
|
442
|
+
id?: number;
|
|
443
|
+
index?: number;
|
|
444
|
+
lat?: string;
|
|
445
|
+
lng?: string;
|
|
446
|
+
rank?: number;
|
|
447
|
+
}
|
|
448
|
+
}
|
|
449
|
+
export type HeatmapRetrieveHeatmapCompetitorsResponse = Array<HeatmapRetrieveHeatmapCompetitorsResponse.HeatmapRetrieveHeatmapCompetitorsResponseItem>;
|
|
450
|
+
export declare namespace HeatmapRetrieveHeatmapCompetitorsResponse {
|
|
451
|
+
interface HeatmapRetrieveHeatmapCompetitorsResponseItem {
|
|
452
|
+
id?: number;
|
|
453
|
+
average?: number;
|
|
454
|
+
average_position?: number;
|
|
455
|
+
market_share?: string;
|
|
456
|
+
market_share_position?: number;
|
|
457
|
+
north_east?: number;
|
|
458
|
+
north_west?: number;
|
|
459
|
+
photos_count?: number;
|
|
460
|
+
place?: HeatmapRetrieveHeatmapCompetitorsResponseItem.Place;
|
|
461
|
+
south_east?: number;
|
|
462
|
+
south_west?: number;
|
|
463
|
+
top_20_points?: number;
|
|
464
|
+
top_3_percentage?: string | null;
|
|
465
|
+
top_3_points?: number;
|
|
466
|
+
top_3_position?: number;
|
|
467
|
+
total_points?: number;
|
|
468
|
+
}
|
|
469
|
+
namespace HeatmapRetrieveHeatmapCompetitorsResponseItem {
|
|
470
|
+
interface Place {
|
|
471
|
+
id?: number;
|
|
472
|
+
address?: string;
|
|
473
|
+
ave_review_rating?: number;
|
|
474
|
+
feature_id?: string;
|
|
475
|
+
google_place_id?: string;
|
|
476
|
+
google_place_serial?: string;
|
|
477
|
+
latitude?: string;
|
|
478
|
+
longitude?: string;
|
|
479
|
+
main_category?: string;
|
|
480
|
+
map_url?: string;
|
|
481
|
+
name?: string;
|
|
482
|
+
phone?: string;
|
|
483
|
+
place_url?: string;
|
|
484
|
+
ranking?: string | null;
|
|
485
|
+
related_categories?: Array<string>;
|
|
486
|
+
review_count?: number;
|
|
487
|
+
thumbnail_url?: string;
|
|
488
|
+
website_url?: string;
|
|
489
|
+
}
|
|
490
|
+
}
|
|
491
|
+
}
|
|
492
|
+
export interface HeatmapRetrieveHeatmapPointResponse {
|
|
493
|
+
id?: number;
|
|
494
|
+
index?: number;
|
|
495
|
+
lat?: number;
|
|
496
|
+
lng?: number;
|
|
497
|
+
places?: Array<HeatmapRetrieveHeatmapPointResponse.Place>;
|
|
498
|
+
rank?: number;
|
|
499
|
+
}
|
|
500
|
+
export declare namespace HeatmapRetrieveHeatmapPointResponse {
|
|
501
|
+
interface Place {
|
|
502
|
+
id?: number;
|
|
503
|
+
address?: string;
|
|
504
|
+
ave_review_rating?: number;
|
|
505
|
+
google_place_id?: string;
|
|
506
|
+
name?: string;
|
|
507
|
+
ranking?: number;
|
|
508
|
+
review_count?: number;
|
|
509
|
+
}
|
|
510
|
+
}
|
|
511
|
+
export interface HeatmapGenerateGridPointsParams {
|
|
512
|
+
/**
|
|
513
|
+
* Spacing between grid points, **in meters** (e.g. `1000` = 1 km, `1609` ≈ 1
|
|
514
|
+
* mile).
|
|
515
|
+
*/
|
|
516
|
+
grid_radius: number;
|
|
517
|
+
/**
|
|
518
|
+
* Number of grid points per side (e.g. 3 = 3×3 grid). Maximum: `13` (produces a
|
|
519
|
+
* 13×13 = 169-point grid).
|
|
520
|
+
*/
|
|
521
|
+
grid_size: number;
|
|
522
|
+
/**
|
|
523
|
+
* Latitude of the grid center.
|
|
524
|
+
*/
|
|
525
|
+
lat: number;
|
|
526
|
+
/**
|
|
527
|
+
* Longitude of the grid center.
|
|
528
|
+
*/
|
|
529
|
+
lng: number;
|
|
530
|
+
/**
|
|
531
|
+
* optional Custom polygon to clip the grid. Points outside the polygon are
|
|
532
|
+
* excluded.
|
|
533
|
+
*/
|
|
534
|
+
polygon?: {
|
|
535
|
+
[key: string]: unknown;
|
|
536
|
+
} | null;
|
|
537
|
+
}
|
|
538
|
+
export interface HeatmapRetrieveHeatmapPointParams {
|
|
539
|
+
/**
|
|
540
|
+
* The ID of the heatmap.
|
|
541
|
+
*/
|
|
542
|
+
heatmap_id: number;
|
|
543
|
+
}
|
|
544
|
+
export interface HeatmapListHeatmapsParams {
|
|
545
|
+
/**
|
|
546
|
+
* Filter by business name (partial match).
|
|
547
|
+
*/
|
|
548
|
+
'filter[business_name]'?: string;
|
|
549
|
+
/**
|
|
550
|
+
* Filter by lead source / company ID.
|
|
551
|
+
*/
|
|
552
|
+
'filter[company_id]'?: number;
|
|
553
|
+
/**
|
|
554
|
+
* Filter by a named date alias instead of a range. Accepted: `today`, `yesterday`,
|
|
555
|
+
* `this_week`, `last_week`, `last_7_days`, `last_30_days`, `last_90_days`,
|
|
556
|
+
* `this_month`, `last_month`, `this_quarter`, `last_quarter`, `this_year`,
|
|
557
|
+
* `year_to_date`, `last_year`, `all_time`.
|
|
558
|
+
*/
|
|
559
|
+
'filter[created_at][date]'?: string;
|
|
560
|
+
/**
|
|
561
|
+
* Filter by creation date — range end (YYYY-MM-DD).
|
|
562
|
+
*/
|
|
563
|
+
'filter[created_at][end_date]'?: string;
|
|
564
|
+
/**
|
|
565
|
+
* Filter by creation date — range start (YYYY-MM-DD).
|
|
566
|
+
*/
|
|
567
|
+
'filter[created_at][start_date]'?: string;
|
|
568
|
+
/**
|
|
569
|
+
* Filter by Google Place ID (exact).
|
|
570
|
+
*/
|
|
571
|
+
'filter[google_place_id]'?: string;
|
|
572
|
+
/**
|
|
573
|
+
* Filter by keyword text (partial match).
|
|
574
|
+
*/
|
|
575
|
+
'filter[keyword]'?: string;
|
|
576
|
+
/**
|
|
577
|
+
* Filter by location ID.
|
|
578
|
+
*/
|
|
579
|
+
'filter[location_id]'?: number;
|
|
580
|
+
/**
|
|
581
|
+
* Filter by search type. Accepted: `google_maps`, `local_pack`.
|
|
582
|
+
*/
|
|
583
|
+
'filter[search_type]'?: string;
|
|
584
|
+
/**
|
|
585
|
+
* Filter by heatmap status. Accepted slugs: `queue`, `in_progress`, `completed`,
|
|
586
|
+
* `incomplete`, `failed`. Numeric values (0–4) are also accepted.
|
|
587
|
+
*/
|
|
588
|
+
'filter[status]'?: string;
|
|
589
|
+
/**
|
|
590
|
+
* Filter by tag name (exact match).
|
|
591
|
+
*/
|
|
592
|
+
'filter[tag]'?: string;
|
|
593
|
+
/**
|
|
594
|
+
* Page number.
|
|
595
|
+
*/
|
|
596
|
+
page?: number;
|
|
597
|
+
/**
|
|
598
|
+
* Number of results per page (default 25).
|
|
599
|
+
*/
|
|
600
|
+
per_page?: number;
|
|
601
|
+
/**
|
|
602
|
+
* Full-text search across keyword and business name.
|
|
603
|
+
*/
|
|
604
|
+
search?: string;
|
|
605
|
+
/**
|
|
606
|
+
* Sort field. Prefix with `-` for descending. Accepted: `created_at`, `average`,
|
|
607
|
+
* `top_3_points`, `top_3_position`, `top_3_percentage`, `review_count`,
|
|
608
|
+
* `review_rating`, `average_position`, `zoom_level`, `grid_size`, `market_share`,
|
|
609
|
+
* `keyword`, `business_name`, `reviews`.
|
|
610
|
+
*/
|
|
611
|
+
sort?: string;
|
|
612
|
+
}
|
|
613
|
+
export interface HeatmapCreateHeatmapParams {
|
|
614
|
+
/**
|
|
615
|
+
* Unit for the radius. Accepted: `km`, `mi`, `m`.
|
|
616
|
+
*/
|
|
617
|
+
distanceType: string;
|
|
618
|
+
/**
|
|
619
|
+
* Radius between grid points in the chosen unit. Used to auto-generate points when
|
|
620
|
+
* `points` is not provided.
|
|
621
|
+
*/
|
|
622
|
+
grid_radius: number;
|
|
623
|
+
/**
|
|
624
|
+
* Number of grid points per side (e.g. 3 = 3×3). Maximum: `13` (13×13 = 169
|
|
625
|
+
* points). Used to auto-generate points when `points` is not provided.
|
|
626
|
+
*/
|
|
627
|
+
grid_size: number | null;
|
|
628
|
+
/**
|
|
629
|
+
* Keywords to track.
|
|
630
|
+
*/
|
|
631
|
+
keyword: Array<string>;
|
|
632
|
+
/**
|
|
633
|
+
* Latitude of the grid center.
|
|
634
|
+
*/
|
|
635
|
+
lat: number;
|
|
636
|
+
/**
|
|
637
|
+
* Longitude of the grid center.
|
|
638
|
+
*/
|
|
639
|
+
lng: number;
|
|
640
|
+
/**
|
|
641
|
+
* Google Place ID of the business. you can get the place_id by calling
|
|
642
|
+
* heatmaps/locations endpoint in case you don't have it.
|
|
643
|
+
*/
|
|
644
|
+
place_id: string;
|
|
645
|
+
/**
|
|
646
|
+
* Search type(s) to run per keyword. Accepted: `google_maps`, `local_pack`.
|
|
647
|
+
*/
|
|
648
|
+
search_type: Array<string>;
|
|
649
|
+
/**
|
|
650
|
+
* optional Pre-computed grid point coordinates (max 169). If provided (must not be
|
|
651
|
+
* empty), `grid_radius` and `grid_size` are ignored. If omitted, points are
|
|
652
|
+
* auto-generated from `grid_size` and `grid_radius`. Use the
|
|
653
|
+
* [Generate grid points](#tag/Heatmap-Points/POST/public/api/v1/heatmap/grid-points)
|
|
654
|
+
* endpoint to compute coordinates from a grid config and pass them here.
|
|
655
|
+
*/
|
|
656
|
+
points?: Array<HeatmapCreateHeatmapParams.Point | null>;
|
|
657
|
+
}
|
|
658
|
+
export declare namespace HeatmapCreateHeatmapParams {
|
|
659
|
+
interface Point {
|
|
660
|
+
/**
|
|
661
|
+
* Latitude of the point.
|
|
662
|
+
*/
|
|
663
|
+
lat: number;
|
|
664
|
+
/**
|
|
665
|
+
* Longitude of the point.
|
|
666
|
+
*/
|
|
667
|
+
lng: number;
|
|
668
|
+
}
|
|
669
|
+
}
|
|
670
|
+
export interface HeatmapListLocationsParams {
|
|
671
|
+
/**
|
|
672
|
+
* Filter by address (partial match).
|
|
673
|
+
*/
|
|
674
|
+
'filter[address]'?: string;
|
|
675
|
+
/**
|
|
676
|
+
* Filter by city.
|
|
677
|
+
*/
|
|
678
|
+
'filter[city]'?: string;
|
|
679
|
+
/**
|
|
680
|
+
* Filter by location ID.
|
|
681
|
+
*/
|
|
682
|
+
'filter[id]'?: number;
|
|
683
|
+
/**
|
|
684
|
+
* Filter by location name (partial match).
|
|
685
|
+
*/
|
|
686
|
+
'filter[location_name]'?: string;
|
|
687
|
+
/**
|
|
688
|
+
* Filter by Google Place ID (exact).
|
|
689
|
+
*/
|
|
690
|
+
'filter[place_id]'?: string;
|
|
691
|
+
/**
|
|
692
|
+
* Filter by primary business category.
|
|
693
|
+
*/
|
|
694
|
+
'filter[primary_category]'?: string;
|
|
695
|
+
/**
|
|
696
|
+
* Filter by state.
|
|
697
|
+
*/
|
|
698
|
+
'filter[state]'?: string;
|
|
699
|
+
/**
|
|
700
|
+
* Filter by zip code.
|
|
701
|
+
*/
|
|
702
|
+
'filter[zip_code]'?: string;
|
|
703
|
+
/**
|
|
704
|
+
* Page number.
|
|
705
|
+
*/
|
|
706
|
+
page?: number;
|
|
707
|
+
/**
|
|
708
|
+
* Number of results per page (default 25).
|
|
709
|
+
*/
|
|
710
|
+
per_page?: number;
|
|
711
|
+
/**
|
|
712
|
+
* Sort field. Prefix with `-` for descending. Accepted: `location_name`,
|
|
713
|
+
* `address`, `city`, `state`, `zip_code`, `primary_category`, `website_url`,
|
|
714
|
+
* `review_count`, `ave_review_rating`, `created_at`, `last_review_date`,
|
|
715
|
+
* `is_connected`, `location_state`, `media_count`, `unreplied_review_count`,
|
|
716
|
+
* `completion_percentage`.
|
|
717
|
+
*/
|
|
718
|
+
sort?: string;
|
|
719
|
+
}
|
|
720
|
+
export declare namespace Heatmap {
|
|
721
|
+
export { type HeatmapCreateHeatmapResponse as HeatmapCreateHeatmapResponse, type HeatmapGenerateGridPointsResponse as HeatmapGenerateGridPointsResponse, type HeatmapListHeatmapsResponse as HeatmapListHeatmapsResponse, type HeatmapListLocationsResponse as HeatmapListLocationsResponse, type HeatmapRetrieveHeatmapResponse as HeatmapRetrieveHeatmapResponse, type HeatmapRetrieveHeatmapCompetitorsResponse as HeatmapRetrieveHeatmapCompetitorsResponse, type HeatmapRetrieveHeatmapPointResponse as HeatmapRetrieveHeatmapPointResponse, type HeatmapGenerateGridPointsParams as HeatmapGenerateGridPointsParams, type HeatmapRetrieveHeatmapPointParams as HeatmapRetrieveHeatmapPointParams, type HeatmapListHeatmapsParams as HeatmapListHeatmapsParams, type HeatmapCreateHeatmapParams as HeatmapCreateHeatmapParams, type HeatmapListLocationsParams as HeatmapListLocationsParams, };
|
|
722
|
+
export { Schedules as Schedules, type ScheduleCreateScheduleResponse as ScheduleCreateScheduleResponse, type ScheduleListSchedulesResponse as ScheduleListSchedulesResponse, type SchedulePauseScheduleResponse as SchedulePauseScheduleResponse, type ScheduleResumeScheduleResponse as ScheduleResumeScheduleResponse, type ScheduleRetrieveScheduleResponse as ScheduleRetrieveScheduleResponse, type ScheduleUpdateScheduleResponse as ScheduleUpdateScheduleResponse, type ScheduleListSchedulesParams as ScheduleListSchedulesParams, type ScheduleCreateScheduleParams as ScheduleCreateScheduleParams, type ScheduleUpdateScheduleParams as ScheduleUpdateScheduleParams, };
|
|
723
|
+
}
|
|
724
|
+
//# sourceMappingURL=heatmap.d.mts.map
|