From 36dccb1ce3e6a755d77dbf889bc615fb5752d5f5 Mon Sep 17 00:00:00 2001 From: tom Date: Tue, 10 Oct 2023 11:54:57 -0700 Subject: [PATCH] chore: audit for responses. remove unused mgmt apis --- apps/api/middleware/openapi.ts | 12 + .../mgmt/v2/customer/connection/index.ts | 5 - apps/api/routes/mgmt/v2/destination/index.ts | 78 - apps/api/routes/mgmt/v2/entity/index.ts | 3 + apps/api/routes/mgmt/v2/index.ts | 4 - apps/api/routes/mgmt/v2/provider/index.ts | 97 -- apps/api/routes/mgmt/v2/sync_config/index.ts | 84 -- .../api/v2/mgmt/create-connection.api.mdx | 21 +- .../api/v2/mgmt/create-destination.api.mdx | 42 - docs/docs/api/v2/mgmt/create-entity.api.mdx | 6 +- .../api/v2/mgmt/create-magic-link.api.mdx | 4 +- docs/docs/api/v2/mgmt/create-provider.api.mdx | 70 - docs/docs/api/v2/mgmt/create-schema.api.mdx | 6 +- .../api/v2/mgmt/create-sync-config.api.mdx | 66 - docs/docs/api/v2/mgmt/delete-customer.api.mdx | 12 +- docs/docs/api/v2/mgmt/delete-entity.api.mdx | 4 +- docs/docs/api/v2/mgmt/delete-provider.api.mdx | 54 - docs/docs/api/v2/mgmt/delete-schema.api.mdx | 4 +- .../api/v2/mgmt/delete-sync-config.api.mdx | 54 - docs/docs/api/v2/mgmt/destinations.tag.mdx | 20 - docs/docs/api/v2/mgmt/get-connection.api.mdx | 21 +- docs/docs/api/v2/mgmt/get-connections.api.mdx | 21 +- docs/docs/api/v2/mgmt/get-customer.api.mdx | 12 +- docs/docs/api/v2/mgmt/get-customers.api.mdx | 12 +- docs/docs/api/v2/mgmt/get-destination.api.mdx | 42 - .../docs/api/v2/mgmt/get-destinations.api.mdx | 42 - docs/docs/api/v2/mgmt/get-entities.api.mdx | 4 +- docs/docs/api/v2/mgmt/get-entity.api.mdx | 4 +- docs/docs/api/v2/mgmt/get-magic-links.api.mdx | 4 +- docs/docs/api/v2/mgmt/get-provider.api.mdx | 54 - docs/docs/api/v2/mgmt/get-providers.api.mdx | 54 - docs/docs/api/v2/mgmt/get-schema.api.mdx | 4 +- docs/docs/api/v2/mgmt/get-schemas.api.mdx | 4 +- docs/docs/api/v2/mgmt/get-sync-config.api.mdx | 54 - .../docs/api/v2/mgmt/get-sync-configs.api.mdx | 4 +- docs/docs/api/v2/mgmt/get-sync-runs.api.mdx | 6 +- docs/docs/api/v2/mgmt/get-syncs.api.mdx | 6 +- docs/docs/api/v2/mgmt/pause-sync.api.mdx | 6 +- docs/docs/api/v2/mgmt/providers.tag.mdx | 20 - docs/docs/api/v2/mgmt/resume-sync.api.mdx | 6 +- docs/docs/api/v2/mgmt/sidebar.js | 2 +- docs/docs/api/v2/mgmt/trigger-sync.api.mdx | 6 +- .../api/v2/mgmt/update-destination.api.mdx | 42 - docs/docs/api/v2/mgmt/update-entity.api.mdx | 6 +- docs/docs/api/v2/mgmt/update-provider.api.mdx | 78 - docs/docs/api/v2/mgmt/update-schema.api.mdx | 6 +- .../api/v2/mgmt/update-sync-config.api.mdx | 66 - docs/docs/api/v2/mgmt/upsert-customer.api.mdx | 21 +- .../api/v2/mgmt/upsert-entity-mapping.api.mdx | 2 +- .../schemas/create_destination.yaml | 21 +- .../schemas/objects/connection.yaml | 2 + .../objects/connection_entity_mapping.yaml | 3 +- .../objects/connection_entity_mappings.yaml | 1 + .../components/schemas/objects/customer.yaml | 1 + .../schemas/objects/destination.yaml | 35 +- .../components/schemas/objects/entity.yaml | 1 + .../schemas/objects/entity_config.yaml | 1 + .../schemas/objects/entity_field_mapping.yaml | 1 + .../schemas/objects/magic_link.yaml | 6 +- .../components/schemas/objects/provider.yaml | 1 + .../objects/provider_entity_mapping.yaml | 1 + .../objects/provider_entity_mappings.yaml | 1 + .../objects/s3_config_at_least_safe.yaml | 18 - .../schemas/objects/s3_config_safe.yaml | 15 - .../schemas/objects/s3_config_unsafe.yaml | 19 - .../components/schemas/objects/schema.yaml | 1 + .../schemas/objects/schema_config.yaml | 1 + .../objects/schema_mappings_config.yaml | 1 + .../schemas/objects/simple_customer.yaml | 19 + .../mgmt/components/schemas/objects/sync.yaml | 47 +- .../schemas/objects/sync_config_data.yaml | 1 + .../components/schemas/objects/sync_run.yaml | 18 + .../sync_with_provider_and_customer.yaml | 40 +- openapi/v2/mgmt/openapi.bundle.json | 1278 +++++------------ openapi/v2/mgmt/openapi.yaml | 20 - .../paths/connections@{connection_id}.yaml | 5 - openapi/v2/mgmt/paths/customers.yaml | 2 +- .../mgmt/paths/customers@{customer_id}.yaml | 18 +- openapi/v2/mgmt/paths/destinations.yaml | 52 - .../paths/destinations@{destination_id}.yaml | 39 - openapi/v2/mgmt/paths/providers.yaml | 39 - .../mgmt/paths/providers@{provider_id}.yaml | 53 - openapi/v2/mgmt/paths/sync_configs.yaml | 21 - openapi/v2/mgmt/paths/sync_runs.yaml | 5 +- openapi/v2/mgmt/paths/syncs.yaml | 1 + openapi/v2/mgmt/paths/syncs@_pause.yaml | 17 +- openapi/v2/mgmt/paths/syncs@_resume.yaml | 19 +- openapi/v2/mgmt/paths/syncs@_trigger.yaml | 23 +- packages/schemas/gen/v2/mgmt.ts | 678 +++------ 89 files changed, 830 insertions(+), 2950 deletions(-) delete mode 100644 apps/api/routes/mgmt/v2/destination/index.ts delete mode 100644 apps/api/routes/mgmt/v2/provider/index.ts delete mode 100644 docs/docs/api/v2/mgmt/create-destination.api.mdx delete mode 100644 docs/docs/api/v2/mgmt/create-provider.api.mdx delete mode 100644 docs/docs/api/v2/mgmt/create-sync-config.api.mdx delete mode 100644 docs/docs/api/v2/mgmt/delete-provider.api.mdx delete mode 100644 docs/docs/api/v2/mgmt/delete-sync-config.api.mdx delete mode 100644 docs/docs/api/v2/mgmt/destinations.tag.mdx delete mode 100644 docs/docs/api/v2/mgmt/get-destination.api.mdx delete mode 100644 docs/docs/api/v2/mgmt/get-destinations.api.mdx delete mode 100644 docs/docs/api/v2/mgmt/get-provider.api.mdx delete mode 100644 docs/docs/api/v2/mgmt/get-providers.api.mdx delete mode 100644 docs/docs/api/v2/mgmt/get-sync-config.api.mdx delete mode 100644 docs/docs/api/v2/mgmt/providers.tag.mdx delete mode 100644 docs/docs/api/v2/mgmt/update-destination.api.mdx delete mode 100644 docs/docs/api/v2/mgmt/update-provider.api.mdx delete mode 100644 docs/docs/api/v2/mgmt/update-sync-config.api.mdx delete mode 100644 openapi/v2/mgmt/components/schemas/objects/s3_config_at_least_safe.yaml delete mode 100644 openapi/v2/mgmt/components/schemas/objects/s3_config_safe.yaml delete mode 100644 openapi/v2/mgmt/components/schemas/objects/s3_config_unsafe.yaml create mode 100644 openapi/v2/mgmt/components/schemas/objects/simple_customer.yaml delete mode 100644 openapi/v2/mgmt/paths/destinations.yaml delete mode 100644 openapi/v2/mgmt/paths/destinations@{destination_id}.yaml delete mode 100644 openapi/v2/mgmt/paths/providers.yaml delete mode 100644 openapi/v2/mgmt/paths/providers@{provider_id}.yaml diff --git a/apps/api/middleware/openapi.ts b/apps/api/middleware/openapi.ts index c7e5a96442..71b56b5f83 100644 --- a/apps/api/middleware/openapi.ts +++ b/apps/api/middleware/openapi.ts @@ -1,3 +1,4 @@ +import { logger } from '@/../../packages/core/lib/logger'; import type { NextFunction, Request, Response } from 'express'; import * as OpenApiValidator from 'express-openapi-validator'; import fs from 'fs'; @@ -39,6 +40,17 @@ export const openapiMiddleware = (specDir: string, version = 'v2') => { validateRequests: { removeAdditional: true, }, + validateResponses: { + onError: (error, body, req) => { + logger.error( + { + error, + originalUrl: req.originalUrl, + }, + 'API reference validation error' + ); + }, + }, }); }; diff --git a/apps/api/routes/mgmt/v2/customer/connection/index.ts b/apps/api/routes/mgmt/v2/customer/connection/index.ts index f91d1152d7..837ecff973 100644 --- a/apps/api/routes/mgmt/v2/customer/connection/index.ts +++ b/apps/api/routes/mgmt/v2/customer/connection/index.ts @@ -107,11 +107,6 @@ export default function init(app: Router): void { req.supaglueApplication.id ); - // enrich with user_id, if we can. - // TODO remove this after users migrate to /_provider_user_id above - const [client] = await remoteService.getCrmRemoteClient(req.params.connection_id); - const { userId } = await client.getUserIdAndDetails(); - return res.status(200).send(snakecaseKeys({ ...connection, userId })); } ); diff --git a/apps/api/routes/mgmt/v2/destination/index.ts b/apps/api/routes/mgmt/v2/destination/index.ts deleted file mode 100644 index c8b5fb569c..0000000000 --- a/apps/api/routes/mgmt/v2/destination/index.ts +++ /dev/null @@ -1,78 +0,0 @@ -import { getDependencyContainer } from '@/dependency_container'; -import type { - CreateDestinationPathParams, - CreateDestinationRequest, - CreateDestinationResponse, - GetDestinationPathParams, - GetDestinationRequest, - GetDestinationResponse, - GetDestinationsPathParams, - GetDestinationsRequest, - GetDestinationsResponse, - UpdateDestinationPathParams, - UpdateDestinationRequest, - UpdateDestinationResponse, -} from '@supaglue/schemas/v2/mgmt'; -import { camelcaseKeys } from '@supaglue/utils/camelcase'; -import { snakecaseKeys } from '@supaglue/utils/snakecase'; -import type { Request, Response } from 'express'; -import { Router } from 'express'; - -const { destinationService } = getDependencyContainer(); - -export default function init(app: Router): void { - const destinationRouter = Router({ mergeParams: true }); - - destinationRouter.get( - '/', - async ( - req: Request, - res: Response - ) => { - const destinations = await destinationService.getDestinationsSafeByApplicationId(req.supaglueApplication.id); - return res.status(200).send(destinations.map(snakecaseKeys)); - } - ); - - destinationRouter.get( - '/:destination_id', - async ( - req: Request, - res: Response - ) => { - const destination = await destinationService.getDestinationSafeById(req.params.destination_id); - return res.status(200).send(snakecaseKeys(destination)); - } - ); - - destinationRouter.post( - '/', - async ( - req: Request, - res: Response - ) => { - const destination = await destinationService.createDestination({ - applicationId: req.supaglueApplication.id, - ...camelcaseKeys(req.body), - }); - return res.status(200).send(snakecaseKeys(destination)); - } - ); - - destinationRouter.put( - '/:destination_id', - async ( - req: Request, - res: Response - ) => { - const destination = await destinationService.updateDestination({ - id: req.params.destination_id, - applicationId: req.supaglueApplication.id, - ...camelcaseKeys(req.body), - }); - return res.status(200).send(snakecaseKeys(destination)); - } - ); - - app.use('/destinations', destinationRouter); -} diff --git a/apps/api/routes/mgmt/v2/entity/index.ts b/apps/api/routes/mgmt/v2/entity/index.ts index 4e5aa45811..ae9dfe47ae 100644 --- a/apps/api/routes/mgmt/v2/entity/index.ts +++ b/apps/api/routes/mgmt/v2/entity/index.ts @@ -23,6 +23,9 @@ import { Router } from 'express'; const { entityService } = getDependencyContainer(); +/** + * @deprecated + */ export default function init(app: Router): void { const entityRouter = Router({ mergeParams: true }); diff --git a/apps/api/routes/mgmt/v2/index.ts b/apps/api/routes/mgmt/v2/index.ts index b9984a9fa7..3a6293a44b 100644 --- a/apps/api/routes/mgmt/v2/index.ts +++ b/apps/api/routes/mgmt/v2/index.ts @@ -4,12 +4,10 @@ import { pinoAndSentryContextMiddleware } from '@/middleware/pino_context'; import { Router } from 'express'; import connectionSyncConfig from './connection_sync_config'; import customer from './customer'; -import destination from './destination'; import entity from './entity'; import entityMapping from './entity_mapping'; import fieldMapping from './field_mapping'; import magicLink from './magic_link'; -import provider from './provider'; import schema from './schema'; import sync from './sync'; import syncConfig from './sync_config'; @@ -23,8 +21,6 @@ export default function init(app: Router): void { v2Router.use(pinoAndSentryContextMiddleware); customer(v2Router); - destination(v2Router); - provider(v2Router); schema(v2Router); syncConfig(v2Router); sync(v2Router); diff --git a/apps/api/routes/mgmt/v2/provider/index.ts b/apps/api/routes/mgmt/v2/provider/index.ts deleted file mode 100644 index 57ad3d9d68..0000000000 --- a/apps/api/routes/mgmt/v2/provider/index.ts +++ /dev/null @@ -1,97 +0,0 @@ -import { getDependencyContainer } from '@/dependency_container'; -import { hideManagedOauthConfig } from '@supaglue/core/mappers/provider'; -import type { - CreateProviderPathParams, - CreateProviderRequest, - CreateProviderResponse, - DeleteProviderPathParams, - DeleteProviderRequest, - DeleteProviderResponse, - GetProviderPathParams, - GetProviderRequest, - GetProviderResponse, - GetProvidersPathParams, - GetProvidersRequest, - GetProvidersResponse, - UpdateProviderPathParams, - UpdateProviderRequest, - UpdateProviderResponse, -} from '@supaglue/schemas/v2/mgmt'; -import type { ProviderCreateParams, ProviderUpdateParams } from '@supaglue/types'; -import { camelcaseKeys } from '@supaglue/utils/camelcase'; -import { snakecaseKeys } from '@supaglue/utils/snakecase'; -import type { Request, Response } from 'express'; -import { Router } from 'express'; - -const { providerService } = getDependencyContainer(); - -export default function init(app: Router): void { - const providerRouter = Router(); - - providerRouter.get( - '/', - async ( - req: Request, - res: Response - ) => { - const providers = await providerService.list(req.supaglueApplication.id); - return res - .status(200) - .send(providers.map((provider) => snakecaseKeys(hideManagedOauthConfig(provider))) as GetProvidersResponse); - } - ); - - providerRouter.post( - '/', - async ( - req: Request, - res: Response - ) => { - const provider = await providerService.create({ - applicationId: req.supaglueApplication.id, - ...camelcaseKeys(req.body), - } as ProviderCreateParams); - return res.status(201).send(snakecaseKeys(hideManagedOauthConfig(provider)) as CreateProviderResponse); - } - ); - - providerRouter.get( - '/:provider_id', - async ( - req: Request, - res: Response - ) => { - const provider = await providerService.getByIdAndApplicationId( - req.params.provider_id, - req.supaglueApplication.id - ); - return res.status(200).send(snakecaseKeys(hideManagedOauthConfig(provider)) as GetProviderResponse); - } - ); - - providerRouter.put( - '/:provider_id', - async ( - req: Request, - res: Response - ) => { - const provider = await providerService.update(req.params.provider_id, req.supaglueApplication.id, { - ...camelcaseKeys(req.body), - } as ProviderUpdateParams); - return res.status(200).send(snakecaseKeys(provider) as UpdateProviderResponse); - } - ); - - providerRouter.delete( - '/:provider_id', - async ( - req: Request, - res: Response - ) => { - await providerService.delete(req.params.provider_id, req.supaglueApplication.id); - return res.status(204).end(); - } - ); - - app.use('/providers', providerRouter); -} diff --git a/apps/api/routes/mgmt/v2/sync_config/index.ts b/apps/api/routes/mgmt/v2/sync_config/index.ts index f30be922ba..58c41232f3 100644 --- a/apps/api/routes/mgmt/v2/sync_config/index.ts +++ b/apps/api/routes/mgmt/v2/sync_config/index.ts @@ -1,23 +1,9 @@ import { getDependencyContainer } from '@/dependency_container'; import type { - CreateSyncConfigPathParams, - CreateSyncConfigRequest, - CreateSyncConfigResponse, - DeleteSyncConfigPathParams, - DeleteSyncConfigRequest, - DeleteSyncConfigResponse, - GetSyncConfigPathParams, - GetSyncConfigRequest, - GetSyncConfigResponse, GetSyncConfigsPathParams, GetSyncConfigsRequest, GetSyncConfigsResponse, - UpdateSyncConfigPathParams, - UpdateSyncConfigRequest, - UpdateSyncConfigResponse, } from '@supaglue/schemas/v2/mgmt'; -import type { CommonObjectType } from '@supaglue/types'; -import { camelcaseKeys } from '@supaglue/utils/camelcase'; import { snakecaseKeys } from '@supaglue/utils/snakecase'; import type { Request, Response } from 'express'; import { Router } from 'express'; @@ -38,75 +24,5 @@ export default function init(app: Router): void { } ); - syncConfigRouter.post( - '/', - async ( - req: Request, - res: Response - ) => { - const syncConfig = await syncConfigService.create({ - applicationId: req.supaglueApplication.id, - ...camelcaseKeys({ - ...req.body, - config: { - ...req.body.config, - common_objects: req.body.config.common_objects?.map((commonObject) => ({ - ...commonObject, - object: commonObject.object as CommonObjectType, - })), - }, - }), - }); - return res.status(201).send(snakecaseKeys(syncConfig)); - } - ); - - syncConfigRouter.get( - '/:sync_config_id', - async ( - req: Request, - res: Response - ) => { - const syncConfig = await syncConfigService.getByIdAndApplicationId( - req.params.sync_config_id, - req.supaglueApplication.id - ); - return res.status(200).send(snakecaseKeys(syncConfig)); - } - ); - - syncConfigRouter.put( - '/:sync_config_id', - async ( - req: Request, - res: Response - ) => { - const syncConfig = await syncConfigService.update(req.params.sync_config_id, req.supaglueApplication.id, { - ...camelcaseKeys({ - ...req.body, - config: { - ...req.body.config, - common_objects: req.body.config.common_objects?.map((commonObject) => ({ - ...commonObject, - object: commonObject.object as CommonObjectType, - })), - }, - }), - }); - return res.status(200).send(snakecaseKeys(syncConfig)); - } - ); - - syncConfigRouter.delete( - '/:sync_config_id', - async ( - req: Request, - res: Response - ) => { - await syncConfigService.delete(req.params.sync_config_id, req.supaglueApplication.id); - return res.status(204).end(); - } - ); - app.use('/sync_configs', syncConfigRouter); } diff --git a/docs/docs/api/v2/mgmt/create-connection.api.mdx b/docs/docs/api/v2/mgmt/create-connection.api.mdx index 0e9e5151b4..5569eb7453 100644 --- a/docs/docs/api/v2/mgmt/create-connection.api.mdx +++ b/docs/docs/api/v2/mgmt/create-connection.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint is for providers that use API key or access key for sidebar_label: "Create a connection" hide_title: true hide_table_of_contents: true -api: {"operationId":"createConnection","description":"This endpoint is for providers that use API key or access key for authentication. Please use [Embedded Links](https://docs.supaglue.com/platform/managed-auth#oauth-20) for providers that support Oauth2 for authentication.","tags":["Connections"],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"apollo","properties":{"provider_name":{"type":"string","enum":["apollo"],"example":"apollo"},"type":{"type":"string","enum":["api_key"],"example":"api_key"},"api_key":{"type":"string","description":"API key for the connected customer.","example":"e0c5545d-77b8-458d-b4bf-fc701a9cecac"}},"required":["provider_name","type","api_key"]},{"type":"object","title":"gong","properties":{"provider_name":{"type":"string","enum":["gong"],"example":"gong"},"type":{"type":"string","enum":["access_key_secret"],"example":"access_key_secret"},"access_key":{"type":"string","description":"Access key for the connected customer.","example":"e0c5545d-77b8-458d-b4bf-fc701a9cecac"},"access_key_secret":{"type":"string","description":"Access key secret for the connected customer.","example":"258a80aa-2e9b-40b0-8d7a-28f858a856f3"}},"required":["provider_name","type","access_key","access_key_secret"]},{"type":"object","title":"salesforce","properties":{"provider_name":{"type":"string","enum":["salesforce"],"example":"salesforce"},"type":{"type":"string","enum":["oauth2"],"example":"oauth2"},"refresh_token":{"type":"string"},"instance_url":{"type":"string"},"login_url":{"type":"string"}},"required":["provider_name","type","refresh_token","instance_url"]},{"type":"object","title":"hubspot","properties":{"provider_name":{"type":"string","enum":["hubspot"],"example":"hubspot"},"type":{"type":"string","enum":["oauth2"],"example":"oauth2"},"refresh_token":{"type":"string"}},"required":["provider_name","type","refresh_token"]}]}}}},"responses":{"200":{"description":"Connection created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement","slack"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}}}},"method":"post","path":"/customers/{customer_id}/connections","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"provider_name":"apollo","type":"api_key","api_key":"e0c5545d-77b8-458d-b4bf-fc701a9cecac"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create a connection","description":{"content":"This endpoint is for providers that use API key or access key for authentication. Please use [Embedded Links](https://docs.supaglue.com/platform/managed-auth#oauth-20) for providers that support Oauth2 for authentication.","type":"text/plain"},"url":{"path":["customers",":customer_id","connections"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"createConnection","description":"This endpoint is for providers that use API key or access key for authentication. Please use [Embedded Links](https://docs.supaglue.com/platform/managed-auth#oauth-20) for providers that support Oauth2 for authentication.","tags":["Connections"],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"apollo","properties":{"provider_name":{"type":"string","enum":["apollo"],"example":"apollo"},"type":{"type":"string","enum":["api_key"],"example":"api_key"},"api_key":{"type":"string","description":"API key for the connected customer.","example":"e0c5545d-77b8-458d-b4bf-fc701a9cecac"}},"required":["provider_name","type","api_key"]},{"type":"object","title":"gong","properties":{"provider_name":{"type":"string","enum":["gong"],"example":"gong"},"type":{"type":"string","enum":["access_key_secret"],"example":"access_key_secret"},"access_key":{"type":"string","description":"Access key for the connected customer.","example":"e0c5545d-77b8-458d-b4bf-fc701a9cecac"},"access_key_secret":{"type":"string","description":"Access key secret for the connected customer.","example":"258a80aa-2e9b-40b0-8d7a-28f858a856f3"}},"required":["provider_name","type","access_key","access_key_secret"]},{"type":"object","title":"salesforce","properties":{"provider_name":{"type":"string","enum":["salesforce"],"example":"salesforce"},"type":{"type":"string","enum":["oauth2"],"example":"oauth2"},"refresh_token":{"type":"string"},"instance_url":{"type":"string"},"login_url":{"type":"string"}},"required":["provider_name","type","refresh_token","instance_url"]},{"type":"object","title":"hubspot","properties":{"provider_name":{"type":"string","enum":["hubspot"],"example":"hubspot"},"type":{"type":"string","enum":["oauth2"],"example":"oauth2"},"refresh_token":{"type":"string"}},"required":["provider_name","type","refresh_token"]}]}}}},"responses":{"200":{"description":"Connection created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement","slack"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","deprecated":true,"properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","deprecated":true,"items":{"type":"object","deprecated":true,"properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","deprecated":true,"properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]},"connection_sync_config":{"type":"object","properties":{"destination_config":{"description":"An object to override the default Destination configuration per connection.","oneOf":[{"description":"Config specific to Postgres destination","type":"object","title":"Postgres","properties":{"type":{"type":"string","enum":["postgres"]},"schema":{"type":"string","description":"The schema you'd like to sync to. This schema must already exist. Supaglue will not create it. If not specified, the schema specified in the Postgres Destination will be used.","example":"customer_1_schema"}},"required":["type","schema"]},{"description":"Config specific to BigQuery destination","type":"object","title":"BigQuery","properties":{"type":{"type":"string","enum":["bigquery"]},"dataset":{"type":"string","description":"The dataset you'd like to sync to. This dataset must already exist. Supaglue will not create it. If not specified, the dataset specified in the BigQuery Destination will be used.","example":"customer_1_dataset"}},"required":["type","dataset"]},{"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nConfig specific to MongoDB destination\n","type":"object","title":"MongoDB (Preview)","properties":{"type":{"type":"string","enum":["mongodb"]},"collection":{"type":"string","description":"The collection you'd like to sync to. This collection must already exist. Supaglue will not create it. If not specified, the schema specified in the MongoDB Destination will be used.","example":"customer_1_schema"}},"required":["type","collection"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig.","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default collection used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}},"custom_objects":{"description":"(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig.\n","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default table used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}}},"title":"connection_sync_config"}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}}}},"method":"post","path":"/customers/{customer_id}/connections","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"provider_name":"apollo","type":"api_key","api_key":"e0c5545d-77b8-458d-b4bf-fc701a9cecac"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create a connection","description":{"content":"This endpoint is for providers that use API key or access key for authentication. Please use [Embedded Links](https://docs.supaglue.com/platform/managed-auth#oauth-20) for providers that support Oauth2 for authentication.","type":"text/plain"},"url":{"path":["customers",":customer_id","connections"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -38,13 +38,26 @@ This endpoint is for providers that use API key or access key for authentication Connection created -
Schema
    schema_mappings_config object
    +
    Schema
      schema_mappings_config objectdeprecated
      This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings). -
      common_objects object[]
    • Array [
      • field_mappings object[]required
    • Array [
    • ]
    • ]
      • standard_objects object[]
    • Array [
      • field_mappings object[]required
    • Array [
    • ]
    • ]
      • entity_mappings object[]
      +
      common_objects object[]
    • Array [
      • field_mappings object[]required
    • Array [
    • ]
    • ]
      • standard_objects object[]
    • Array [
      • field_mappings object[]required
    • Array [
    • ]
    • ]
      • entity_mappings object[]deprecated
      This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping). -
    • Array [
      • object object
      field_mappings object[]
    • Array [
    • ]
    • ]
+
  • Array [
    • object object
    field_mappings object[]
  • Array [
  • ]
  • ]
    • connection_sync_config object
    destination_config object
    + +An object to override the default Destination configuration per connection. + +
    oneOf
    standard_objects object[]
    + +A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig. + +
  • Array [
    • oneOf
  • ]
    • custom_objects object[]
    + +(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig. + + +
  • Array [
    • oneOf
  • ]
    •  \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/create-destination.api.mdx b/docs/docs/api/v2/mgmt/create-destination.api.mdx deleted file mode 100644 index b22bb7e5cf..0000000000 --- a/docs/docs/api/v2/mgmt/create-destination.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: create-destination -title: "Create destination" -description: "Create destination" -sidebar_label: "Create destination" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"createDestination","tags":["Destinations"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"postgres","properties":{"type":{"type":"string","enum":["supaglue"],"example":"supaglue"}},"required":["type"]},{"type":"object","title":"postgres","properties":{"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"ssl_mode":{"type":"string","enum":["disable","allow","prefer","require"],"example":"disable"},"password":{"type":"string","example":"mysensitivepassword"}},"required":["host","port","database","schema","user","password"],"title":"postgres_config_unsafe"}},"required":["name","type","config"]},{"type":"object","title":"bigquery","properties":{"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"},"private_key":{"type":"string","example":"-----BEGIN PRIVATE KEY-----\\nMII..."}},"required":["client_email","private_key"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_unsafe"}},"required":["name","type","config"]},{"type":"object","title":"mongodb","properties":{"name":{"type":"string","example":"My MongoDB Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"},"password":{"type":"string","example":"mysensitivepassword"}},"required":["host","database","user","password"],"title":"mongodb_config_unsafe"}},"required":["name","type","config"]}],"title":"create_destination"}}}},"responses":{"201":{"description":"Destination created","content":{"application/json":{"schema":{"example":{"id":"2cce5aed-e8fc-41b2-bff6-6ddbc1f99285","application_id":"e52286c9-3038-4fa2-a2b8-3ec9759d20cb","name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser"}},"oneOf":[{"type":"object","title":"supaglue","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"type":{"type":"string","enum":["supaglue"],"example":"supaglue"},"version":{"type":"number"}},"required":["id","application_id","type","version"]},{"type":"object","title":"postgres","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"ssl_mode":{"type":"string","enum":["disable","allow","prefer","require"],"example":"disable"}},"required":["host","port","database","schema","user"],"title":"postgres_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"bigquery","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"}},"required":["client_email"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"mongodb","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My Mongo Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"}},"required":["host","database","user"],"title":"mongodb_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]}],"title":"destination"}}}}},"description":"Create destination","method":"post","path":"/destinations","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"type":"supaglue"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create destination","description":{"type":"text/plain"},"url":{"path":["destinations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "post api-method" -info_path: api/v2/mgmt/management-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

    Create destination

    - - - - - - - -Create destination - -## Request - -

    Body

    required
      oneOf
      config objectrequired
      config objectrequired
      credentials objectrequired
      config objectrequired
    - -Destination created - -
    Schema
      oneOf
      config objectrequired
      config objectrequired
      credentials objectrequired
      config objectrequired
    - \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/create-entity.api.mdx b/docs/docs/api/v2/mgmt/create-entity.api.mdx index 6b6eafd7aa..48849a3ecc 100644 --- a/docs/docs/api/v2/mgmt/create-entity.api.mdx +++ b/docs/docs/api/v2/mgmt/create-entity.api.mdx @@ -5,7 +5,7 @@ description: "Create entity" sidebar_label: "Create entity" hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"createEntity","tags":["Entities"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["name","config"],"title":"create_update_entity"}}}},"responses":{"201":{"description":"Entity created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}},"description":"Create entity","method":"post","path":"/entities","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"my-entity","config":{"fields":[{"name":"apolla_first_name"}],"allow_additional_field_mappings":true}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create entity","description":{"type":"text/plain"},"url":{"path":["entities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"deprecated":true,"operationId":"createEntity","tags":["Entities"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"my-entity"},"config":{"type":"object","deprecated":true,"properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["name","config"],"title":"create_update_entity"}}}},"responses":{"201":{"description":"Entity created","content":{"application/json":{"schema":{"type":"object","deprecated":true,"properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","deprecated":true,"properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}},"description":"Create entity","method":"post","path":"/entities","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"my-entity"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create entity","description":{"type":"text/plain"},"url":{"path":["entities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -38,9 +38,9 @@ Create entity ## Request -

    Body

    required
      config objectrequired
      fields object[]required
    • Array [
    • ]
    +

    Body

    required
      config objectrequireddeprecated
      fields object[]required
    • Array [
    • ]
    Entity created -
    Schema
      config objectrequired
      fields object[]required
    • Array [
    • ]
    +
    Schema
      config objectrequireddeprecated
      fields object[]required
    • Array [
    • ]
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/create-magic-link.api.mdx b/docs/docs/api/v2/mgmt/create-magic-link.api.mdx index 6a14d891e4..cc06a3d88b 100644 --- a/docs/docs/api/v2/mgmt/create-magic-link.api.mdx +++ b/docs/docs/api/v2/mgmt/create-magic-link.api.mdx @@ -5,7 +5,7 @@ description: "Create magic link" sidebar_label: "Create magic link" hide_title: true hide_table_of_contents: true -api: {"operationId":"createMagicLink","tags":["Magic Links"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"string","example":"my-customer-1"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement","slack"],"example":"hubspot","title":"provider_name"},"return_url":{"type":"string","description":"URL to redirect to after the connection is authorized.","example":"https://app.myapp.com/connections/123456"},"expiration_secs":{"type":"number","example":18000}},"required":["customer_id","provider_name","expiration_secs","return_url"],"title":"create_magic_link"}}}},"responses":{"201":{"description":"Entity created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"ec208408-db29-4705-b39e-4d33070b4ef6"},"status":{"type":"string","example":"created"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement","slack"],"example":"hubspot","title":"provider_name"},"url":{"type":"string","description":"The magic link URL.","example":"https://app.hubspot.com/contacts/123456"},"return_url":{"type":"string","description":"URL to redirect to after the connection is authorized.","example":"https://app.myapp.com/connections/123456"},"expires_at":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00Z"}},"required":["id","status","application_id","customer_id","provider_id","provider_name","expires_at","url","return_url"],"title":"magic_link"}}}}},"description":"Create magic link","method":"post","path":"/magic_links","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"customer_id":"my-customer-1","provider_name":"hubspot","return_url":"https://app.myapp.com/connections/123456","expiration_secs":18000},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create magic link","description":{"type":"text/plain"},"url":{"path":["magic_links"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"createMagicLink","tags":["Magic Links"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"string","example":"my-customer-1"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement","slack"],"example":"hubspot","title":"provider_name"},"return_url":{"type":"string","description":"URL to redirect to after the connection is authorized.","example":"https://app.myapp.com/connections/123456"},"expiration_secs":{"type":"number","example":18000}},"required":["customer_id","provider_name","expiration_secs","return_url"],"title":"create_magic_link"}}}},"responses":{"201":{"description":"Entity created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"ec208408-db29-4705-b39e-4d33070b4ef6"},"status":{"type":"string","enum":["new","consumed"],"example":"new"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement","slack"],"example":"hubspot","title":"provider_name"},"url":{"type":"string","description":"The magic link URL.","example":"https://app.hubspot.com/contacts/123456"},"return_url":{"type":"string","description":"URL to redirect to after the connection is authorized.","example":"https://app.myapp.com/connections/123456"},"expires_at":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00Z","description":"Any ISO formatted date-time string indicating when the magic link expires."}},"required":["id","status","application_id","customer_id","provider_id","provider_name","expires_at","url","return_url"],"title":"magic_link"}}}}},"description":"Create magic link","method":"post","path":"/magic_links","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"customer_id":"my-customer-1","provider_name":"hubspot","return_url":"https://app.myapp.com/connections/123456","expiration_secs":18000},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create magic link","description":{"type":"text/plain"},"url":{"path":["magic_links"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -38,5 +38,5 @@ Create magic link Entity created -
    Schema
    +
    Schema
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/create-provider.api.mdx b/docs/docs/api/v2/mgmt/create-provider.api.mdx deleted file mode 100644 index 8f3e70ef54..0000000000 --- a/docs/docs/api/v2/mgmt/create-provider.api.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -id: create-provider -title: "Create provider" -description: "Create provider" -sidebar_label: "Create provider" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"createProvider","tags":["Providers"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"crm","properties":{"auth_type":{"type":"string","enum":["oauth2"]},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"category":{"type":"string","enum":["crm"]},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule"],"title":"provider_name_crm"}},"required":["auth_type","config","category","name"]},{"type":"object","title":"engagement","properties":{"auth_type":{"type":"string","enum":["oauth2"]},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"category":{"type":"string","enum":["engagement"]},"name":{"type":"string","enum":["outreach","apollo","salesloft"],"title":"provider_name_engagement"}},"required":["auth_type","config","category","name"]},{"type":"object","title":"no category","properties":{"auth_type":{"type":"string","enum":["api_key"]},"category":{"type":"string","enum":["no_category"]},"name":{"type":"string","enum":["intercom","gong","linear"],"title":"provider_name_no_category"}},"required":["auth_type"]}],"title":"create_provider"}}}},"responses":{"201":{"description":"Provider created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"0c4cb91f-e392-46f5-8934-17496371f932"},"application_id":{"type":"string","example":"273e1c75-3b6d-439a-9b8e-c6ac407df92a"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"auth_type":{"type":"string","enum":["oauth2","api_key"],"example":"oauth2"},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement","slack"],"example":"hubspot","title":"provider_name"},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers.","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}}},"required":["id","application_id","category","auth_type","name"],"title":"provider"}}}}},"description":"Create provider","method":"post","path":"/providers","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"auth_type":"oauth2","config":{"provider_app_id":"my_app_id","use_managed_oauth":true,"oauth":{"oauth_scopes":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"],"credentials":{"oauth_client_id":"7393b5a4-5e20-4648-87af-b7b297793fd1","oauth_client_secret":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}}},"objects":{"common":[{"name":"account","schema_id":"328a8cb3-8345-4b02-b661-ee13b4f76806"}],"standard":[{"name":"Account","schema_id":"777ea826-5776-4347-9ece-47bbb17ccdd4"}]},"category":"crm","name":"hubspot"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create provider","description":{"type":"text/plain"},"url":{"path":["providers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "post api-method" -info_path: api/v2/mgmt/management-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

    Create provider

    - - - - - - - -Create provider - -## Request - -

    Body

    required
      oneOf
      config objectrequired
      - -An object that stores Oauth2/API key/access key related credentials. - -
      oauth objectrequired
      credentials objectrequired
      objects object
      - -This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers. - -
      common object[]
    • Array [
    • ]
      • standard object[]
    • Array [
    • ]
      • config objectrequired
      - -An object that stores Oauth2/API key/access key related credentials. - -
      oauth objectrequired
      credentials objectrequired
      objects object
      - -This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers. - -
      common object[]
    • Array [
    • ]
      • standard object[]
    • Array [
    • ]
    - -Provider created - -
    Schema
      config object
      - -An object that stores Oauth2/API key/access key related credentials. - -
      oauth objectrequired
      credentials objectrequired
      objects object
      - -This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers. - -
      common object[]
    • Array [
    • ]
      • standard object[]
    • Array [
    • ]
      • entity_mappings object[]
      - -This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers. - -
    • Array [
      • object object
      field_mappings object[]
    • Array [
    • ]
    • ]
    - \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/create-schema.api.mdx b/docs/docs/api/v2/mgmt/create-schema.api.mdx index 1ff1f1b75b..ede54c094c 100644 --- a/docs/docs/api/v2/mgmt/create-schema.api.mdx +++ b/docs/docs/api/v2/mgmt/create-schema.api.mdx @@ -5,7 +5,7 @@ description: "Create schema" sidebar_label: "Create schema" hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"createSchema","tags":["Schemas"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["name","config"],"title":"create_update_schema"}}}},"responses":{"201":{"description":"Schema created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}},"description":"Create schema","method":"post","path":"/schemas","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"my-schema","config":{"fields":[{"name":"apolla_first_name","mapped_name":"FirstName"}],"allow_additional_field_mappings":false}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create schema","description":{"type":"text/plain"},"url":{"path":["schemas"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"deprecated":true,"operationId":"createSchema","tags":["Schemas"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"my-schema"},"config":{"type":"object","deprecated":true,"properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["name","config"],"title":"create_update_schema"}}}},"responses":{"201":{"description":"Schema created","content":{"application/json":{"schema":{"type":"object","deprecated":true,"properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","deprecated":true,"properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}},"description":"Create schema","method":"post","path":"/schemas","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"my-schema"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create schema","description":{"type":"text/plain"},"url":{"path":["schemas"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -38,9 +38,9 @@ Create schema ## Request -

    Body

    required
      config objectrequired
      fields object[]required
    • Array [
    • ]
    +

    Body

    required
      config objectrequireddeprecated
      fields object[]required
    • Array [
    • ]
    Schema created -
    Schema
      config objectrequired
      fields object[]required
    • Array [
    • ]
    +
    Schema
      config objectrequireddeprecated
      fields object[]required
    • Array [
    • ]
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/create-sync-config.api.mdx b/docs/docs/api/v2/mgmt/create-sync-config.api.mdx deleted file mode 100644 index c1728dc447..0000000000 --- a/docs/docs/api/v2/mgmt/create-sync-config.api.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -id: create-sync-config -title: "Create Sync Config" -description: "Create Sync Config" -sidebar_label: "Create Sync Config" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"createSyncConfig","tags":["SyncConfigs"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["destination_id","provider_id","config"],"title":"create_update_sync_config"}}}},"responses":{"201":{"description":"SyncConfig created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}},"description":"Create Sync Config","method":"post","path":"/sync_configs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"destination_id":"6e7baa88-84dd-4dbc-902a-14522c2984eb","provider_id":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af","config":{"default_config":{"period_ms":60000,"strategy":"full then incremental","auto_start_on_connection":true},"common_objects":[{"object":"contact"}],"standard_objects":[{"object":"Contact"}],"entities":[{"entity_id":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}]}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create Sync Config","description":{"type":"text/plain"},"url":{"path":["sync_configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "post api-method" -info_path: api/v2/mgmt/management-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

    Create Sync Config

    - - - - - - - -Create Sync Config - -## Request - -

    Body

    required
      config objectrequired
      default_config objectrequired
      - -Configuration options for "how" to sync. - -
      = 60000`"} schema={{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."}}>
      common_objects object[]
      - -A list of Supaglue objects to be synced. - -
    • Array [
    • ]
      • standard_objects object[]
      - -A list of case-sensitive Provider objects to be synced. - -
    • Array [
    • ]
      • entities object[]
    • Array [
    • ]
    - -SyncConfig created - -
    Schema
      config objectrequired
      default_config objectrequired
      - -Configuration options for "how" to sync. - -
      = 60000`"} schema={{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."}}>
      common_objects object[]
      - -A list of Supaglue objects to be synced. - -
    • Array [
    • ]
      • standard_objects object[]
      - -A list of case-sensitive Provider objects to be synced. - -
    • Array [
    • ]
      • entities object[]
    • Array [
    • ]
    - \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/delete-customer.api.mdx b/docs/docs/api/v2/mgmt/delete-customer.api.mdx index b0d594f11c..dcce40b876 100644 --- a/docs/docs/api/v2/mgmt/delete-customer.api.mdx +++ b/docs/docs/api/v2/mgmt/delete-customer.api.mdx @@ -5,7 +5,7 @@ description: "Delete customer" sidebar_label: "Delete customer" hide_title: true hide_table_of_contents: true -api: {"operationId":"deleteCustomer","tags":["Customers"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Customer","content":{"application/json":{"schema":{"type":"object","properties":{"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"},"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement","slack"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}},"required":["application_id","name","email","customer_id"],"title":"customer"},"examples":{"Example":{"value":{"application_id":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69","name":"MyCompany Inc","email":"contact@mycompany.com","customer_id":"your-customers-unique-application-id"}}}}}}},"description":"Delete customer","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","example":"your-customers-unique-application-id"}}],"method":"delete","path":"/customers/{customer_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete customer","description":{"type":"text/plain"},"url":{"path":["customers",":customer_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"deleteCustomer","tags":["Customers"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Customer","content":{"application/json":{"schema":{"type":"object","properties":{"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"}},"required":["application_id","name","email","customer_id"]}}}}},"description":"Delete customer","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","example":"your-customers-unique-application-id"}}],"method":"delete","path":"/customers/{customer_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete customer","description":{"type":"text/plain"},"url":{"path":["customers",":customer_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "delete api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -38,13 +38,5 @@ Delete customer Customer -
    Schema
      connections object[]
    • Array [
      • schema_mappings_config object
      - -This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings). - -
      common_objects object[]
    • Array [
      • field_mappings object[]required
    • Array [
    • ]
    • ]
      • standard_objects object[]
    • Array [
      • field_mappings object[]required
    • Array [
    • ]
    • ]
      • entity_mappings object[]
      - -This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping). - -
    • Array [
      • object object
      field_mappings object[]
    • Array [
    • ]
    • ]
    • ]
    +
    Schema
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/delete-entity.api.mdx b/docs/docs/api/v2/mgmt/delete-entity.api.mdx index 10b8067777..8f6ee60996 100644 --- a/docs/docs/api/v2/mgmt/delete-entity.api.mdx +++ b/docs/docs/api/v2/mgmt/delete-entity.api.mdx @@ -5,7 +5,7 @@ description: "Delete entity" sidebar_label: "Delete entity" hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"deleteEntity","tags":["Entities"],"security":[{"x-api-key":[]}],"responses":{"204":{"description":"Entity","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}},"description":"Delete entity","parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"delete","path":"/entities/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete entity","description":{"type":"text/plain"},"url":{"path":["entities",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"deprecated":true,"operationId":"deleteEntity","tags":["Entities"],"security":[{"x-api-key":[]}],"responses":{"204":{"description":"Entity","content":{"application/json":{"schema":{"type":"object","deprecated":true,"properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","deprecated":true,"properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}},"description":"Delete entity","parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"delete","path":"/entities/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete entity","description":{"type":"text/plain"},"url":{"path":["entities",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "delete api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -42,5 +42,5 @@ Delete entity Entity -
    Schema
      config objectrequired
      fields object[]required
    • Array [
    • ]
    +
    Schema
      config objectrequireddeprecated
      fields object[]required
    • Array [
    • ]
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/delete-provider.api.mdx b/docs/docs/api/v2/mgmt/delete-provider.api.mdx deleted file mode 100644 index fb4ad4ef14..0000000000 --- a/docs/docs/api/v2/mgmt/delete-provider.api.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: delete-provider -title: "Delete provider" -description: "Delete provider" -sidebar_label: "Delete provider" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"deleteProvider","tags":["Providers"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Provider","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"0c4cb91f-e392-46f5-8934-17496371f932"},"application_id":{"type":"string","example":"273e1c75-3b6d-439a-9b8e-c6ac407df92a"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"auth_type":{"type":"string","enum":["oauth2","api_key"],"example":"oauth2"},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement","slack"],"example":"hubspot","title":"provider_name"},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers.","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}}},"required":["id","application_id","category","auth_type","name"],"title":"provider"}}}}},"description":"Delete provider","parameters":[{"name":"provider_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"delete","path":"/providers/{provider_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete provider","description":{"type":"text/plain"},"url":{"path":["providers",":provider_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"provider_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "delete api-method" -info_path: api/v2/mgmt/management-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

    Delete provider

    - - - - - - - -Delete provider - -## Request - -

    Path Parameters

    - -Provider - -
    Schema
      config object
      - -An object that stores Oauth2/API key/access key related credentials. - -
      oauth objectrequired
      credentials objectrequired
      objects object
      - -This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers. - -
      common object[]
    • Array [
    • ]
      • standard object[]
    • Array [
    • ]
      • entity_mappings object[]
      - -This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers. - -
    • Array [
      • object object
      field_mappings object[]
    • Array [
    • ]
    • ]
    - \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/delete-schema.api.mdx b/docs/docs/api/v2/mgmt/delete-schema.api.mdx index 3836ef509d..02039511c7 100644 --- a/docs/docs/api/v2/mgmt/delete-schema.api.mdx +++ b/docs/docs/api/v2/mgmt/delete-schema.api.mdx @@ -5,7 +5,7 @@ description: "Delete schema" sidebar_label: "Delete schema" hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"deleteSchema","tags":["Schemas"],"security":[{"x-api-key":[]}],"responses":{"204":{"description":"Schema","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}},"description":"Delete schema","parameters":[{"name":"schema_id","in":"path","required":true,"schema":{"type":"string","example":"a821d59d-8b4c-4ad9-aeec-1292d2e28701"}}],"method":"delete","path":"/schemas/{schema_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete schema","description":{"type":"text/plain"},"url":{"path":["schemas",":schema_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"schema_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"deprecated":true,"operationId":"deleteSchema","tags":["Schemas"],"security":[{"x-api-key":[]}],"responses":{"204":{"description":"Schema","content":{"application/json":{"schema":{"type":"object","deprecated":true,"properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","deprecated":true,"properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}},"description":"Delete schema","parameters":[{"name":"schema_id","in":"path","required":true,"schema":{"type":"string","example":"a821d59d-8b4c-4ad9-aeec-1292d2e28701"}}],"method":"delete","path":"/schemas/{schema_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete schema","description":{"type":"text/plain"},"url":{"path":["schemas",":schema_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"schema_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "delete api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -42,5 +42,5 @@ Delete schema Schema -
    Schema
      config objectrequired
      fields object[]required
    • Array [
    • ]
    +
    Schema
      config objectrequireddeprecated
      fields object[]required
    • Array [
    • ]
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/delete-sync-config.api.mdx b/docs/docs/api/v2/mgmt/delete-sync-config.api.mdx deleted file mode 100644 index b9c9deaf5e..0000000000 --- a/docs/docs/api/v2/mgmt/delete-sync-config.api.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: delete-sync-config -title: "Delete Sync Config" -description: "Delete Sync Config" -sidebar_label: "Delete Sync Config" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"deleteSyncConfig","tags":["SyncConfigs"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"SyncConfig","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}},"description":"Delete Sync Config","parameters":[{"name":"sync_config_id","in":"path","required":true,"schema":{"type":"string","example":"d583ec72-55d4-4f35-9668-f6c759674cc1"}}],"method":"delete","path":"/sync_configs/{sync_config_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete Sync Config","description":{"type":"text/plain"},"url":{"path":["sync_configs",":sync_config_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"sync_config_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "delete api-method" -info_path: api/v2/mgmt/management-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

    Delete Sync Config

    - - - - - - - -Delete Sync Config - -## Request - -

    Path Parameters

    - -SyncConfig - -
    Schema
      config objectrequired
      default_config objectrequired
      - -Configuration options for "how" to sync. - -
      = 60000`"} schema={{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."}}>
      common_objects object[]
      - -A list of Supaglue objects to be synced. - -
    • Array [
    • ]
      • standard_objects object[]
      - -A list of case-sensitive Provider objects to be synced. - -
    • Array [
    • ]
      • entities object[]
    • Array [
    • ]
    - \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/destinations.tag.mdx b/docs/docs/api/v2/mgmt/destinations.tag.mdx deleted file mode 100644 index 9f3e883d69..0000000000 --- a/docs/docs/api/v2/mgmt/destinations.tag.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: destinations -title: "Destinations" -description: "Destinations" -custom_edit_url: null ---- - - - -A `Destination` is a data store where we write data in your infrastructure. - - - -```mdx-code-block -import DocCardList from '@theme/DocCardList'; -import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; - - -``` - \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-connection.api.mdx b/docs/docs/api/v2/mgmt/get-connection.api.mdx index e87f1590f9..428d951d8c 100644 --- a/docs/docs/api/v2/mgmt/get-connection.api.mdx +++ b/docs/docs/api/v2/mgmt/get-connection.api.mdx @@ -5,7 +5,7 @@ description: "Get connection" sidebar_label: "Get connection" hide_title: true hide_table_of_contents: true -api: {"operationId":"getConnection","tags":["Connections"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Connection","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement","slack"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"},{"type":"object","properties":{"user_id":{"type":"string","description":"The id of the user associated with this connection. This is sometimes also known as the owner."}}}]}}}}},"description":"Get connection","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/customers/{customer_id}/connections/{connection_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get connection","description":{"type":"text/plain"},"url":{"path":["customers",":customer_id","connections",":connection_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"connection_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getConnection","tags":["Connections"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Connection","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement","slack"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","deprecated":true,"properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","deprecated":true,"items":{"type":"object","deprecated":true,"properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","deprecated":true,"properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]},"connection_sync_config":{"type":"object","properties":{"destination_config":{"description":"An object to override the default Destination configuration per connection.","oneOf":[{"description":"Config specific to Postgres destination","type":"object","title":"Postgres","properties":{"type":{"type":"string","enum":["postgres"]},"schema":{"type":"string","description":"The schema you'd like to sync to. This schema must already exist. Supaglue will not create it. If not specified, the schema specified in the Postgres Destination will be used.","example":"customer_1_schema"}},"required":["type","schema"]},{"description":"Config specific to BigQuery destination","type":"object","title":"BigQuery","properties":{"type":{"type":"string","enum":["bigquery"]},"dataset":{"type":"string","description":"The dataset you'd like to sync to. This dataset must already exist. Supaglue will not create it. If not specified, the dataset specified in the BigQuery Destination will be used.","example":"customer_1_dataset"}},"required":["type","dataset"]},{"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nConfig specific to MongoDB destination\n","type":"object","title":"MongoDB (Preview)","properties":{"type":{"type":"string","enum":["mongodb"]},"collection":{"type":"string","description":"The collection you'd like to sync to. This collection must already exist. Supaglue will not create it. If not specified, the schema specified in the MongoDB Destination will be used.","example":"customer_1_schema"}},"required":["type","collection"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig.","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default collection used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}},"custom_objects":{"description":"(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig.\n","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default table used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}}},"title":"connection_sync_config"}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}]}}}}},"description":"Get connection","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/customers/{customer_id}/connections/{connection_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get connection","description":{"type":"text/plain"},"url":{"path":["customers",":customer_id","connections",":connection_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"connection_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -38,13 +38,26 @@ Get connection Connection -
    Schema
      schema_mappings_config object
      +
      Schema
        schema_mappings_config objectdeprecated
        This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings). -
        common_objects object[]
      • Array [
        • field_mappings object[]required
      • Array [
      • ]
      • ]
        • standard_objects object[]
      • Array [
        • field_mappings object[]required
      • Array [
      • ]
      • ]
        • entity_mappings object[]
        +
        common_objects object[]
      • Array [
        • field_mappings object[]required
      • Array [
      • ]
      • ]
        • standard_objects object[]
      • Array [
        • field_mappings object[]required
      • Array [
      • ]
      • ]
        • entity_mappings object[]deprecated
        This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping). -
      • Array [
        • object object
        field_mappings object[]
      • Array [
      • ]
      • ]
    +
  • Array [
    • object object
    field_mappings object[]
  • Array [
  • ]
  • ]
    • connection_sync_config object
    destination_config object
    + +An object to override the default Destination configuration per connection. + +
    oneOf
    standard_objects object[]
    + +A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig. + +
  • Array [
    • oneOf
  • ]
    • custom_objects object[]
    + +(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig. + + +
  • Array [
    • oneOf
  • ]
    •  \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-connections.api.mdx b/docs/docs/api/v2/mgmt/get-connections.api.mdx index d8782d9587..383048e29a 100644 --- a/docs/docs/api/v2/mgmt/get-connections.api.mdx +++ b/docs/docs/api/v2/mgmt/get-connections.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of connections" sidebar_label: "List connections" hide_title: true hide_table_of_contents: true -api: {"operationId":"getConnections","tags":["Connections"],"security":[{"x-api-key":[]}],"description":"Get a list of connections","responses":{"200":{"description":"Connections","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement","slack"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}}}}},"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/customers/{customer_id}/connections","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List connections","description":{"content":"Get a list of connections","type":"text/plain"},"url":{"path":["customers",":customer_id","connections"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getConnections","tags":["Connections"],"security":[{"x-api-key":[]}],"description":"Get a list of connections","responses":{"200":{"description":"Connections","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement","slack"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","deprecated":true,"properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","deprecated":true,"items":{"type":"object","deprecated":true,"properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","deprecated":true,"properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]},"connection_sync_config":{"type":"object","properties":{"destination_config":{"description":"An object to override the default Destination configuration per connection.","oneOf":[{"description":"Config specific to Postgres destination","type":"object","title":"Postgres","properties":{"type":{"type":"string","enum":["postgres"]},"schema":{"type":"string","description":"The schema you'd like to sync to. This schema must already exist. Supaglue will not create it. If not specified, the schema specified in the Postgres Destination will be used.","example":"customer_1_schema"}},"required":["type","schema"]},{"description":"Config specific to BigQuery destination","type":"object","title":"BigQuery","properties":{"type":{"type":"string","enum":["bigquery"]},"dataset":{"type":"string","description":"The dataset you'd like to sync to. This dataset must already exist. Supaglue will not create it. If not specified, the dataset specified in the BigQuery Destination will be used.","example":"customer_1_dataset"}},"required":["type","dataset"]},{"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nConfig specific to MongoDB destination\n","type":"object","title":"MongoDB (Preview)","properties":{"type":{"type":"string","enum":["mongodb"]},"collection":{"type":"string","description":"The collection you'd like to sync to. This collection must already exist. Supaglue will not create it. If not specified, the schema specified in the MongoDB Destination will be used.","example":"customer_1_schema"}},"required":["type","collection"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig.","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default collection used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}},"custom_objects":{"description":"(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig.\n","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default table used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}}},"title":"connection_sync_config"}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}}}}},"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/customers/{customer_id}/connections","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List connections","description":{"content":"Get a list of connections","type":"text/plain"},"url":{"path":["customers",":customer_id","connections"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -38,13 +38,26 @@ Get a list of connections Connections -
    Schema
    • Array [
      • schema_mappings_config object
      +
      Schema
      • Array [
        • schema_mappings_config objectdeprecated
        This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings). -
        common_objects object[]
      • Array [
        • field_mappings object[]required
      • Array [
      • ]
      • ]
        • standard_objects object[]
      • Array [
        • field_mappings object[]required
      • Array [
      • ]
      • ]
        • entity_mappings object[]
        +
        common_objects object[]
      • Array [
        • field_mappings object[]required
      • Array [
      • ]
      • ]
        • standard_objects object[]
      • Array [
        • field_mappings object[]required
      • Array [
      • ]
      • ]
        • entity_mappings object[]deprecated
        This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping). -
      • Array [
        • object object
        field_mappings object[]
      • Array [
      • ]
      • ]
      • ]
    +
  • Array [
    • object object
    field_mappings object[]
  • Array [
  • ]
  • ]
    • connection_sync_config object
    destination_config object
    + +An object to override the default Destination configuration per connection. + +
    oneOf
    standard_objects object[]
    + +A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig. + +
  • Array [
    • oneOf
  • ]
    • custom_objects object[]
    + +(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig. + + +
  • Array [
    • oneOf
  • ]
  • ]
    • \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-customer.api.mdx b/docs/docs/api/v2/mgmt/get-customer.api.mdx index e1e0b8f373..ae1df51b2e 100644 --- a/docs/docs/api/v2/mgmt/get-customer.api.mdx +++ b/docs/docs/api/v2/mgmt/get-customer.api.mdx @@ -5,7 +5,7 @@ description: "Get customer" sidebar_label: "Get customer" hide_title: true hide_table_of_contents: true -api: {"operationId":"getCustomer","tags":["Customers"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Customer","content":{"application/json":{"schema":{"type":"object","properties":{"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"},"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement","slack"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}},"required":["application_id","name","email","customer_id"],"title":"customer"},"examples":{"Example":{"value":{"application_id":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69","name":"MyCompany Inc","email":"contact@mycompany.com","customer_id":"your-customers-unique-application-id"}}}}}}},"description":"Get customer","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","example":"your-customers-unique-application-id"}}],"method":"get","path":"/customers/{customer_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get customer","description":{"type":"text/plain"},"url":{"path":["customers",":customer_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getCustomer","tags":["Customers"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Customer","content":{"application/json":{"schema":{"type":"object","properties":{"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"}},"required":["application_id","name","email","customer_id"]}}}}},"description":"Get customer","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","example":"your-customers-unique-application-id"}}],"method":"get","path":"/customers/{customer_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get customer","description":{"type":"text/plain"},"url":{"path":["customers",":customer_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -38,13 +38,5 @@ Get customer Customer -
    Schema
      connections object[]
    • Array [
      • schema_mappings_config object
      - -This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings). - -
      common_objects object[]
    • Array [
      • field_mappings object[]required
    • Array [
    • ]
    • ]
      • standard_objects object[]
    • Array [
      • field_mappings object[]required
    • Array [
    • ]
    • ]
      • entity_mappings object[]
      - -This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping). - -
    • Array [
      • object object
      field_mappings object[]
    • Array [
    • ]
    • ]
    • ]
    +
    Schema
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-customers.api.mdx b/docs/docs/api/v2/mgmt/get-customers.api.mdx index 00cf0e4f36..560ee5ad61 100644 --- a/docs/docs/api/v2/mgmt/get-customers.api.mdx +++ b/docs/docs/api/v2/mgmt/get-customers.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of customers" sidebar_label: "List customers" hide_title: true hide_table_of_contents: true -api: {"operationId":"getCustomers","tags":["Customers"],"security":[{"x-api-key":[]}],"description":"Get a list of customers","responses":{"200":{"description":"Customers","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"},"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement","slack"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}},"required":["application_id","name","email","customer_id"],"title":"customer"}}}}}},"method":"get","path":"/customers","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List customers","description":{"content":"Get a list of customers","type":"text/plain"},"url":{"path":["customers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getCustomers","tags":["Customers"],"security":[{"x-api-key":[]}],"description":"Get a list of customers","responses":{"200":{"description":"Customers","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"}},"required":["application_id","name","email","customer_id"]}}}}}},"method":"get","path":"/customers","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List customers","description":{"content":"Get a list of customers","type":"text/plain"},"url":{"path":["customers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -38,13 +38,5 @@ Get a list of customers Customers -
    Schema
    • Array [
      • connections object[]
    • Array [
      • schema_mappings_config object
      - -This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings). - -
      common_objects object[]
    • Array [
      • field_mappings object[]required
    • Array [
    • ]
    • ]
      • standard_objects object[]
    • Array [
      • field_mappings object[]required
    • Array [
    • ]
    • ]
      • entity_mappings object[]
      - -This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping). - -
    • Array [
      • object object
      field_mappings object[]
    • Array [
    • ]
    • ]
    • ]
    • ]
    +
    Schema
    • Array [
    • ]
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-destination.api.mdx b/docs/docs/api/v2/mgmt/get-destination.api.mdx deleted file mode 100644 index 4a16509f3c..0000000000 --- a/docs/docs/api/v2/mgmt/get-destination.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-destination -title: "Get destination" -description: "Get destination" -sidebar_label: "Get destination" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"getDestination","tags":["Destinations"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Destination","content":{"application/json":{"schema":{"example":{"id":"2cce5aed-e8fc-41b2-bff6-6ddbc1f99285","application_id":"e52286c9-3038-4fa2-a2b8-3ec9759d20cb","name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser"}},"oneOf":[{"type":"object","title":"supaglue","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"type":{"type":"string","enum":["supaglue"],"example":"supaglue"},"version":{"type":"number"}},"required":["id","application_id","type","version"]},{"type":"object","title":"postgres","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"ssl_mode":{"type":"string","enum":["disable","allow","prefer","require"],"example":"disable"}},"required":["host","port","database","schema","user"],"title":"postgres_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"bigquery","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"}},"required":["client_email"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"mongodb","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My Mongo Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"}},"required":["host","database","user"],"title":"mongodb_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]}],"title":"destination"}}}}},"description":"Get destination","parameters":[{"name":"destination_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/destinations/{destination_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get destination","description":{"type":"text/plain"},"url":{"path":["destinations",":destination_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"destination_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "get api-method" -info_path: api/v2/mgmt/management-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

    Get destination

    - - - - - - - -Get destination - -## Request - -

    Path Parameters

    - -Destination - -
    Schema
      oneOf
      config objectrequired
      config objectrequired
      credentials objectrequired
      config objectrequired
    - \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-destinations.api.mdx b/docs/docs/api/v2/mgmt/get-destinations.api.mdx deleted file mode 100644 index 4db4eb5e39..0000000000 --- a/docs/docs/api/v2/mgmt/get-destinations.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-destinations -title: "List destinations" -description: "Get a list of destinations" -sidebar_label: "List destinations" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"getDestinations","tags":["Destinations"],"security":[{"x-api-key":[]}],"description":"Get a list of destinations","responses":{"200":{"description":"Destinations","content":{"application/json":{"schema":{"type":"array","items":{"example":{"id":"2cce5aed-e8fc-41b2-bff6-6ddbc1f99285","application_id":"e52286c9-3038-4fa2-a2b8-3ec9759d20cb","name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser"}},"oneOf":[{"type":"object","title":"supaglue","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"type":{"type":"string","enum":["supaglue"],"example":"supaglue"},"version":{"type":"number"}},"required":["id","application_id","type","version"]},{"type":"object","title":"postgres","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"ssl_mode":{"type":"string","enum":["disable","allow","prefer","require"],"example":"disable"}},"required":["host","port","database","schema","user"],"title":"postgres_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"bigquery","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"}},"required":["client_email"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"mongodb","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My Mongo Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"}},"required":["host","database","user"],"title":"mongodb_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]}],"title":"destination"},"example":[{"id":"92bc3460-a301-4116-8d1f-6e5f8252c2e2","application_id":"9b9a31bb-9fe4-4fa5-ba84-4c035a27f258","name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"my_database","schema":"public","user":"user","password":"password"}}]}}}}},"method":"get","path":"/destinations","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List destinations","description":{"content":"Get a list of destinations","type":"text/plain"},"url":{"path":["destinations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "get api-method" -info_path: api/v2/mgmt/management-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

    List destinations

    - - - - - - - -Get a list of destinations - -## Request - -
    - -Destinations - -
    Schema
    • Array [
      • oneOf
      config objectrequired
      config objectrequired
      credentials objectrequired
      config objectrequired
    • ]
    - \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-entities.api.mdx b/docs/docs/api/v2/mgmt/get-entities.api.mdx index fd0c4f5645..52ca75aaad 100644 --- a/docs/docs/api/v2/mgmt/get-entities.api.mdx +++ b/docs/docs/api/v2/mgmt/get-entities.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of entities" sidebar_label: "List entities" hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"getEntities","tags":["Entities"],"security":[{"x-api-key":[]}],"description":"Get a list of entities","responses":{"200":{"description":"Entities","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}}},"method":"get","path":"/entities","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List entities","description":{"content":"Get a list of entities","type":"text/plain"},"url":{"path":["entities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"deprecated":true,"operationId":"getEntities","tags":["Entities"],"security":[{"x-api-key":[]}],"description":"Get a list of entities","responses":{"200":{"description":"Entities","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","deprecated":true,"properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","deprecated":true,"properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}}},"method":"get","path":"/entities","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List entities","description":{"content":"Get a list of entities","type":"text/plain"},"url":{"path":["entities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -42,5 +42,5 @@ Get a list of entities Entities -
    Schema
    • Array [
      • config objectrequired
      fields object[]required
    • Array [
    • ]
    • ]
    +
    Schema
    • Array [
      • config objectrequireddeprecated
      fields object[]required
    • Array [
    • ]
    • ]
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-entity.api.mdx b/docs/docs/api/v2/mgmt/get-entity.api.mdx index d2beaba176..f23d510d7d 100644 --- a/docs/docs/api/v2/mgmt/get-entity.api.mdx +++ b/docs/docs/api/v2/mgmt/get-entity.api.mdx @@ -5,7 +5,7 @@ description: "Get entity" sidebar_label: "Get entity" hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"getEntity","tags":["Entities"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Entity","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}},"description":"Get entity","parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/entities/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get entity","description":{"type":"text/plain"},"url":{"path":["entities",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"deprecated":true,"operationId":"getEntity","tags":["Entities"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Entity","content":{"application/json":{"schema":{"type":"object","deprecated":true,"properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","deprecated":true,"properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}},"description":"Get entity","parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/entities/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get entity","description":{"type":"text/plain"},"url":{"path":["entities",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -42,5 +42,5 @@ Get entity Entity -
    Schema
      config objectrequired
      fields object[]required
    • Array [
    • ]
    +
    Schema
      config objectrequireddeprecated
      fields object[]required
    • Array [
    • ]
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-magic-links.api.mdx b/docs/docs/api/v2/mgmt/get-magic-links.api.mdx index 3c37864812..a4a456807b 100644 --- a/docs/docs/api/v2/mgmt/get-magic-links.api.mdx +++ b/docs/docs/api/v2/mgmt/get-magic-links.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of magic links" sidebar_label: "List magic links" hide_title: true hide_table_of_contents: true -api: {"operationId":"getMagicLinks","tags":["Magic Links"],"security":[{"x-api-key":[]}],"description":"Get a list of magic links","responses":{"200":{"description":"Magic Links","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"ec208408-db29-4705-b39e-4d33070b4ef6"},"status":{"type":"string","example":"created"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement","slack"],"example":"hubspot","title":"provider_name"},"url":{"type":"string","description":"The magic link URL.","example":"https://app.hubspot.com/contacts/123456"},"return_url":{"type":"string","description":"URL to redirect to after the connection is authorized.","example":"https://app.myapp.com/connections/123456"},"expires_at":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00Z"}},"required":["id","status","application_id","customer_id","provider_id","provider_name","expires_at","url","return_url"],"title":"magic_link"}}}}}},"method":"get","path":"/magic_links","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List magic links","description":{"content":"Get a list of magic links","type":"text/plain"},"url":{"path":["magic_links"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getMagicLinks","tags":["Magic Links"],"security":[{"x-api-key":[]}],"description":"Get a list of magic links","responses":{"200":{"description":"Magic Links","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"ec208408-db29-4705-b39e-4d33070b4ef6"},"status":{"type":"string","enum":["new","consumed"],"example":"new"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement","slack"],"example":"hubspot","title":"provider_name"},"url":{"type":"string","description":"The magic link URL.","example":"https://app.hubspot.com/contacts/123456"},"return_url":{"type":"string","description":"URL to redirect to after the connection is authorized.","example":"https://app.myapp.com/connections/123456"},"expires_at":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00Z","description":"Any ISO formatted date-time string indicating when the magic link expires."}},"required":["id","status","application_id","customer_id","provider_id","provider_name","expires_at","url","return_url"],"title":"magic_link"}}}}}},"method":"get","path":"/magic_links","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List magic links","description":{"content":"Get a list of magic links","type":"text/plain"},"url":{"path":["magic_links"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -38,5 +38,5 @@ Get a list of magic links Magic Links -
    Schema
    • Array [
    • ]
    +
    Schema
    • Array [
    • ]
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-provider.api.mdx b/docs/docs/api/v2/mgmt/get-provider.api.mdx deleted file mode 100644 index dfb8409c77..0000000000 --- a/docs/docs/api/v2/mgmt/get-provider.api.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: get-provider -title: "Get provider" -description: "Get provider" -sidebar_label: "Get provider" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"getProvider","tags":["Providers"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Provider","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"0c4cb91f-e392-46f5-8934-17496371f932"},"application_id":{"type":"string","example":"273e1c75-3b6d-439a-9b8e-c6ac407df92a"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"auth_type":{"type":"string","enum":["oauth2","api_key"],"example":"oauth2"},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement","slack"],"example":"hubspot","title":"provider_name"},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers.","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}}},"required":["id","application_id","category","auth_type","name"],"title":"provider"}}}}},"description":"Get provider","parameters":[{"name":"provider_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/providers/{provider_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get provider","description":{"type":"text/plain"},"url":{"path":["providers",":provider_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"provider_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "get api-method" -info_path: api/v2/mgmt/management-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

    Get provider

    - - - - - - - -Get provider - -## Request - -

    Path Parameters

    - -Provider - -
    Schema
      config object
      - -An object that stores Oauth2/API key/access key related credentials. - -
      oauth objectrequired
      credentials objectrequired
      objects object
      - -This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers. - -
      common object[]
    • Array [
    • ]
      • standard object[]
    • Array [
    • ]
      • entity_mappings object[]
      - -This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers. - -
    • Array [
      • object object
      field_mappings object[]
    • Array [
    • ]
    • ]
    - \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-providers.api.mdx b/docs/docs/api/v2/mgmt/get-providers.api.mdx deleted file mode 100644 index bc7d19d3e4..0000000000 --- a/docs/docs/api/v2/mgmt/get-providers.api.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: get-providers -title: "List providers" -description: "Get a list of providers" -sidebar_label: "List providers" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"getProviders","tags":["Providers"],"security":[{"x-api-key":[]}],"description":"Get a list of providers","responses":{"200":{"description":"Providers","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"0c4cb91f-e392-46f5-8934-17496371f932"},"application_id":{"type":"string","example":"273e1c75-3b6d-439a-9b8e-c6ac407df92a"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"auth_type":{"type":"string","enum":["oauth2","api_key"],"example":"oauth2"},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement","slack"],"example":"hubspot","title":"provider_name"},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers.","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}}},"required":["id","application_id","category","auth_type","name"],"title":"provider"}}}}}},"method":"get","path":"/providers","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List providers","description":{"content":"Get a list of providers","type":"text/plain"},"url":{"path":["providers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "get api-method" -info_path: api/v2/mgmt/management-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

    List providers

    - - - - - - - -Get a list of providers - -## Request - -
    - -Providers - -
    Schema
    • Array [
      • config object
      - -An object that stores Oauth2/API key/access key related credentials. - -
      oauth objectrequired
      credentials objectrequired
      objects object
      - -This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers. - -
      common object[]
    • Array [
    • ]
      • standard object[]
    • Array [
    • ]
      • entity_mappings object[]
      - -This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers. - -
    • Array [
      • object object
      field_mappings object[]
    • Array [
    • ]
    • ]
    • ]
    - \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-schema.api.mdx b/docs/docs/api/v2/mgmt/get-schema.api.mdx index 91c45d869f..f846b4f0b3 100644 --- a/docs/docs/api/v2/mgmt/get-schema.api.mdx +++ b/docs/docs/api/v2/mgmt/get-schema.api.mdx @@ -5,7 +5,7 @@ description: "Get schema" sidebar_label: "Get schema" hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"getSchema","tags":["Schemas"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Schema","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}},"description":"Get schema","parameters":[{"name":"schema_id","in":"path","required":true,"schema":{"type":"string","example":"a821d59d-8b4c-4ad9-aeec-1292d2e28701"}}],"method":"get","path":"/schemas/{schema_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get schema","description":{"type":"text/plain"},"url":{"path":["schemas",":schema_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"schema_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"deprecated":true,"operationId":"getSchema","tags":["Schemas"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Schema","content":{"application/json":{"schema":{"type":"object","deprecated":true,"properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","deprecated":true,"properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}},"description":"Get schema","parameters":[{"name":"schema_id","in":"path","required":true,"schema":{"type":"string","example":"a821d59d-8b4c-4ad9-aeec-1292d2e28701"}}],"method":"get","path":"/schemas/{schema_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get schema","description":{"type":"text/plain"},"url":{"path":["schemas",":schema_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"schema_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -42,5 +42,5 @@ Get schema Schema -
    Schema
      config objectrequired
      fields object[]required
    • Array [
    • ]
    +
    Schema
      config objectrequireddeprecated
      fields object[]required
    • Array [
    • ]
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-schemas.api.mdx b/docs/docs/api/v2/mgmt/get-schemas.api.mdx index e39e905623..6a69796f93 100644 --- a/docs/docs/api/v2/mgmt/get-schemas.api.mdx +++ b/docs/docs/api/v2/mgmt/get-schemas.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of schemas" sidebar_label: "List schemas" hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"getSchemas","tags":["Schemas"],"security":[{"x-api-key":[]}],"description":"Get a list of schemas","responses":{"200":{"description":"Schemas","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}}},"method":"get","path":"/schemas","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List schemas","description":{"content":"Get a list of schemas","type":"text/plain"},"url":{"path":["schemas"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"deprecated":true,"operationId":"getSchemas","tags":["Schemas"],"security":[{"x-api-key":[]}],"description":"Get a list of schemas","responses":{"200":{"description":"Schemas","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","deprecated":true,"properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","deprecated":true,"properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}}},"method":"get","path":"/schemas","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List schemas","description":{"content":"Get a list of schemas","type":"text/plain"},"url":{"path":["schemas"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -42,5 +42,5 @@ Get a list of schemas Schemas -
    Schema
    • Array [
      • config objectrequired
      fields object[]required
    • Array [
    • ]
    • ]
    +
    Schema
    • Array [
      • config objectrequireddeprecated
      fields object[]required
    • Array [
    • ]
    • ]
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-sync-config.api.mdx b/docs/docs/api/v2/mgmt/get-sync-config.api.mdx deleted file mode 100644 index d88643d2ad..0000000000 --- a/docs/docs/api/v2/mgmt/get-sync-config.api.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: get-sync-config -title: "Get Sync Config" -description: "Get Sync Config" -sidebar_label: "Get Sync Config" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"getSyncConfig","tags":["SyncConfigs"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"SyncConfig","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}},"description":"Get Sync Config","parameters":[{"name":"sync_config_id","in":"path","required":true,"schema":{"type":"string","example":"d583ec72-55d4-4f35-9668-f6c759674cc1"}}],"method":"get","path":"/sync_configs/{sync_config_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get Sync Config","description":{"type":"text/plain"},"url":{"path":["sync_configs",":sync_config_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"sync_config_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "get api-method" -info_path: api/v2/mgmt/management-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

    Get Sync Config

    - - - - - - - -Get Sync Config - -## Request - -

    Path Parameters

    - -SyncConfig - -
    Schema
      config objectrequired
      default_config objectrequired
      - -Configuration options for "how" to sync. - -
      = 60000`"} schema={{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."}}>
      common_objects object[]
      - -A list of Supaglue objects to be synced. - -
    • Array [
    • ]
      • standard_objects object[]
      - -A list of case-sensitive Provider objects to be synced. - -
    • Array [
    • ]
      • entities object[]
    • Array [
    • ]
    - \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-sync-configs.api.mdx b/docs/docs/api/v2/mgmt/get-sync-configs.api.mdx index d2a7c11eec..d08fca9549 100644 --- a/docs/docs/api/v2/mgmt/get-sync-configs.api.mdx +++ b/docs/docs/api/v2/mgmt/get-sync-configs.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of Sync Configs" sidebar_label: "List Sync Configs" hide_title: true hide_table_of_contents: true -api: {"operationId":"getSyncConfigs","tags":["SyncConfigs"],"security":[{"x-api-key":[]}],"description":"Get a list of Sync Configs","responses":{"200":{"description":"SyncConfigs","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}}},"method":"get","path":"/sync_configs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List Sync Configs","description":{"content":"Get a list of Sync Configs","type":"text/plain"},"url":{"path":["sync_configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getSyncConfigs","tags":["SyncConfigs"],"security":[{"x-api-key":[]}],"description":"Get a list of Sync Configs","responses":{"200":{"description":"SyncConfigs","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","deprecated":true,"items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}}},"method":"get","path":"/sync_configs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List Sync Configs","description":{"content":"Get a list of Sync Configs","type":"text/plain"},"url":{"path":["sync_configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -50,5 +50,5 @@ A list of Supaglue objects to be synced. A list of case-sensitive Provider objects to be synced. -
  • Array [
  • ]
    • entities object[]
  • Array [
  • ]
  • ]
    • +
  • Array [
  • ]
    • entities object[]deprecated
  • Array [
  • ]
  • ]
    • \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-sync-runs.api.mdx b/docs/docs/api/v2/mgmt/get-sync-runs.api.mdx index bd1139fce4..6e7dfb6987 100644 --- a/docs/docs/api/v2/mgmt/get-sync-runs.api.mdx +++ b/docs/docs/api/v2/mgmt/get-sync-runs.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of SyncRuns." sidebar_label: "Get SyncRuns" hide_title: true hide_table_of_contents: true -api: {"operationId":"getSyncRuns","tags":["SyncRuns"],"security":[{"x-api-key":[]}],"description":"Get a list of SyncRuns.","parameters":[{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"page_size","in":"query","schema":{"type":"string","example":"100"},"description":"Number of results to return per page"},{"name":"customer_id","in":"query","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application"},{"name":"provider_name","in":"query","schema":{"type":"string","example":"salesforce"},"description":"The provider name"},{"name":"object_type","in":"query","schema":{"type":"string","enum":["common","standard","custom"],"example":"standard"}},{"name":"object","in":"query","schema":{"type":"string","example":"account"},"description":"The object to filter by"},{"name":"entity_id","in":"query","schema":{"type":"string","example":"e74b5a4f-f252-4a6c-940c-f35873498543"},"description":"The entity id to filter by"},{"name":"status","in":"query","schema":{"type":"string","example":"SUCCESS"},"description":"The status to filter by (case-insensitive)"},{"name":"start_timestamp","in":"query","schema":{"type":"string","example":">2021-01-06T03:24:53.434326Z"},"description":"The start time to filter by. Should start with one of [>, <] followed by an ISO 8601 timestamp."},{"name":"end_timestamp","in":"query","schema":{"type":"string","example":">2021-01-06T03:24:53.434326Z"},"description":"The end time to filter by. Should start with [>, <] followed by an ISO 8601 timestamp."}],"responses":{"200":{"description":"SyncRun","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous"],"title":"pagination"},{"type":"object","properties":{"results":{"type":"array","items":{"oneOf":[{"type":"object","title":"Data model: Objects","properties":{"object_type":{"type":"string","enum":["common","standard","custom"]},"object":{"type":"string"},"error_message":{"type":"string","nullable":true},"start_timestamp":{"type":"string","example":"2023-02-22T19:55:17.559Z"},"end_timestamp":{"type":"string","nullable":true,"example":"2023-02-22T20:55:17.559Z"},"application_id":{"type":"string","example":"974125fa-ffb6-47fc-b12f-44c566fc5da1"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement","slack"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"status":{"type":"string","enum":["SUCCESS","IN_PROGRESS","FAILURE"]},"num_records_synced":{"type":"number","nullable":true,"example":100}},"required":["object_type","object","start_timestamp","end_timestamp","application_id","customer_id","status","error_message","provider_name","category","connection_id","num_records_synced"]},{"type":"object","title":"Data model: Entities","properties":{"entity_id":{"type":"string"},"error_message":{"type":"string","nullable":true},"start_timestamp":{"type":"string","example":"2023-02-22T19:55:17.559Z"},"end_timestamp":{"type":"string","nullable":true,"example":"2023-02-22T20:55:17.559Z"},"application_id":{"type":"string","example":"974125fa-ffb6-47fc-b12f-44c566fc5da1"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement","slack"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"status":{"type":"string","enum":["SUCCESS","IN_PROGRESS","FAILURE"]},"num_records_synced":{"type":"number","nullable":true,"example":100}},"required":["entity_id","start_timestamp","end_timestamp","application_id","customer_id","status","error_message","provider_name","category","connection_id","num_records_synced"]}],"title":"sync_run"}}}}]}}}}},"method":"get","path":"/sync-runs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get SyncRuns","description":{"content":"Get a list of SyncRuns.","type":"text/plain"},"url":{"path":["sync-runs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"Number of results to return per page","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"customer_id","value":""},{"disabled":false,"description":{"content":"The provider name","type":"text/plain"},"key":"provider_name","value":""},{"disabled":false,"key":"object_type","value":""},{"disabled":false,"description":{"content":"The object to filter by","type":"text/plain"},"key":"object","value":""},{"disabled":false,"description":{"content":"The entity id to filter by","type":"text/plain"},"key":"entity_id","value":""},{"disabled":false,"description":{"content":"The status to filter by (case-insensitive)","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"The start time to filter by. Should start with one of [>, <] followed by an ISO 8601 timestamp.","type":"text/plain"},"key":"start_timestamp","value":""},{"disabled":false,"description":{"content":"The end time to filter by. Should start with [>, <] followed by an ISO 8601 timestamp.","type":"text/plain"},"key":"end_timestamp","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getSyncRuns","tags":["SyncRuns"],"security":[{"x-api-key":[]}],"description":"Get a list of SyncRuns.","parameters":[{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"page_size","in":"query","schema":{"type":"string","example":"100"},"description":"Number of results to return per page"},{"name":"customer_id","in":"query","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application"},{"name":"provider_name","in":"query","schema":{"type":"string","example":"salesforce"},"description":"The provider name"},{"name":"object_type","in":"query","schema":{"type":"string","enum":["common","standard","custom"],"example":"standard"}},{"name":"object","in":"query","schema":{"type":"string","example":"account"},"description":"The object to filter by"},{"name":"entity_id","deprecated":true,"in":"query","schema":{"type":"string","example":"e74b5a4f-f252-4a6c-940c-f35873498543"},"description":"The entity id to filter by"},{"name":"status","in":"query","schema":{"type":"string","example":"SUCCESS"},"description":"The status to filter by (case-insensitive)"},{"name":"start_timestamp","in":"query","schema":{"type":"string","example":">2021-01-06T03:24:53.434326Z"},"description":"The start time to filter by. Should start with one of [`>`, `<`] followed by an ISO 8601 timestamp."},{"name":"end_timestamp","in":"query","schema":{"type":"string","example":">2021-01-06T03:24:53.434326Z"},"description":"The end time to filter by. Should start with [`>`, `<`] followed by an ISO 8601 timestamp."}],"responses":{"200":{"description":"SyncRun","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous"],"title":"pagination"},{"type":"object","properties":{"results":{"type":"array","items":{"oneOf":[{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"20eb4da3-6b38-4ec6-a82d-ecee59a9d6d9"},"sync_id":{"type":"string","example":"629525f8-f6f7-436c-80fa-1cb23acc5bf8"},"object_type":{"type":"string","enum":["common","standard","custom"]},"object":{"type":"string"},"error_message":{"type":"string","nullable":true},"start_timestamp":{"type":"string","example":"2023-02-22T19:55:17.559Z"},"end_timestamp":{"type":"string","nullable":true,"example":"2023-02-22T20:55:17.559Z"},"application_id":{"type":"string","example":"974125fa-ffb6-47fc-b12f-44c566fc5da1"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement","slack"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"status":{"type":"string","enum":["SUCCESS","IN_PROGRESS","FAILURE"]},"num_records_synced":{"type":"number","nullable":true,"example":100}},"required":["id","sync_id","object_type","object","start_timestamp","end_timestamp","application_id","customer_id","status","error_message","provider_name","category","connection_id","num_records_synced"]},{"type":"object","title":"Data model: Entities","deprecated":true,"properties":{"id":{"type":"string","example":"20eb4da3-6b38-4ec6-a82d-ecee59a9d6d9"},"sync_id":{"type":"string","example":"629525f8-f6f7-436c-80fa-1cb23acc5bf8"},"entity_id":{"type":"string","deprecated":true},"error_message":{"type":"string","nullable":true},"start_timestamp":{"type":"string","example":"2023-02-22T19:55:17.559Z"},"end_timestamp":{"type":"string","nullable":true,"example":"2023-02-22T20:55:17.559Z"},"application_id":{"type":"string","example":"974125fa-ffb6-47fc-b12f-44c566fc5da1"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement","slack"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"status":{"type":"string","enum":["SUCCESS","IN_PROGRESS","FAILURE"]},"num_records_synced":{"type":"number","nullable":true,"example":100}},"required":["id","sync_id","entity_id","start_timestamp","end_timestamp","application_id","customer_id","status","error_message","provider_name","category","connection_id","num_records_synced"]}],"title":"sync_run"}}}}]}}}}},"method":"get","path":"/sync-runs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get SyncRuns","description":{"content":"Get a list of SyncRuns.","type":"text/plain"},"url":{"path":["sync-runs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"Number of results to return per page","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"customer_id","value":""},{"disabled":false,"description":{"content":"The provider name","type":"text/plain"},"key":"provider_name","value":""},{"disabled":false,"key":"object_type","value":""},{"disabled":false,"description":{"content":"The object to filter by","type":"text/plain"},"key":"object","value":""},{"disabled":false,"description":{"content":"The entity id to filter by","type":"text/plain"},"key":"entity_id","value":""},{"disabled":false,"description":{"content":"The status to filter by (case-insensitive)","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"The start time to filter by. Should start with one of [`>`, `<`] followed by an ISO 8601 timestamp.","type":"text/plain"},"key":"start_timestamp","value":""},{"disabled":false,"description":{"content":"The end time to filter by. Should start with [`>`, `<`] followed by an ISO 8601 timestamp.","type":"text/plain"},"key":"end_timestamp","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -34,9 +34,9 @@ Get a list of SyncRuns. ## Request -

    Query Parameters

      2021-01-06T03:24:53.434326Z"},"description":"The start time to filter by. Should start with one of [>, <] followed by an ISO 8601 timestamp."}}>2021-01-06T03:24:53.434326Z"},"description":"The end time to filter by. Should start with [>, <] followed by an ISO 8601 timestamp."}}>
    +

    Query Parameters

      2021-01-06T03:24:53.434326Z"},"description":"The start time to filter by. Should start with one of [`>`, `<`] followed by an ISO 8601 timestamp."}}>2021-01-06T03:24:53.434326Z"},"description":"The end time to filter by. Should start with [`>`, `<`] followed by an ISO 8601 timestamp."}}>
    SyncRun -
    Schema
      results object[]
    • Array [
      • oneOf
    • ]
    +
    Schema
      results object[]
    • Array [
      • oneOf
    • ]
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-syncs.api.mdx b/docs/docs/api/v2/mgmt/get-syncs.api.mdx index 95b3cc08db..55ebcd2d0c 100644 --- a/docs/docs/api/v2/mgmt/get-syncs.api.mdx +++ b/docs/docs/api/v2/mgmt/get-syncs.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of Syncs." sidebar_label: "Get Syncs" hide_title: true hide_table_of_contents: true -api: {"operationId":"getSyncs","tags":["Syncs"],"security":[{"x-api-key":[]}],"description":"Get a list of Syncs.","parameters":[{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"page_size","in":"query","schema":{"type":"string","example":"100"},"description":"Number of results to return per page"},{"name":"customer_id","in":"query","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application"},{"name":"provider_name","in":"query","schema":{"type":"string","example":"salesforce"},"description":"The provider name"},{"name":"object_type","in":"query","schema":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"description":"The object type to filter by"},{"name":"object","in":"query","schema":{"type":"string","example":"contact"},"description":"The object to filter by"},{"name":"entity_id","in":"query","schema":{"type":"string","example":"e74b5a4f-f252-4a6c-940c-f35873498543"},"description":"The entity id to filter by"}],"responses":{"200":{"description":"Sync","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous"],"title":"pagination"},{"type":"object","properties":{"results":{"type":"array","items":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"id":{"type":"string","example":"971cb76d-9558-42fe-8f3b-8a531c32bd5f"},"type":{"type":"string","enum":["entity"],"example":"entity"},"entity_id":{"type":"string","example":"70da3830-b717-49cb-91f0-22fb3f09a97a"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false},"provider_name":{"type":"string","example":"hubspot"},"customer_id":{"type":"string","example":"my-customer-1"}},"required":["id","type","entity_id","connection_id","sync_config_id","paused","provider_name","customer_id"]},{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"971cb76d-9558-42fe-8f3b-8a531c32bd5f"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"object":{"type":"string","example":"contact"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false},"provider_name":{"type":"string","example":"hubspot"},"customer_id":{"type":"string","example":"my-customer-1"}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused","provider_name","customer_id"]}],"title":"sync_with_provider_and_customer"}}}}]}}}}},"method":"get","path":"/syncs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get Syncs","description":{"content":"Get a list of Syncs.","type":"text/plain"},"url":{"path":["syncs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"Number of results to return per page","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"customer_id","value":""},{"disabled":false,"description":{"content":"The provider name","type":"text/plain"},"key":"provider_name","value":""},{"disabled":false,"description":{"content":"The object type to filter by","type":"text/plain"},"key":"object_type","value":""},{"disabled":false,"description":{"content":"The object to filter by","type":"text/plain"},"key":"object","value":""},{"disabled":false,"description":{"content":"The entity id to filter by","type":"text/plain"},"key":"entity_id","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getSyncs","tags":["Syncs"],"security":[{"x-api-key":[]}],"description":"Get a list of Syncs.","parameters":[{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"page_size","in":"query","schema":{"type":"string","example":"100"},"description":"Number of results to return per page"},{"name":"customer_id","in":"query","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application"},{"name":"provider_name","in":"query","schema":{"type":"string","example":"salesforce"},"description":"The provider name"},{"name":"object_type","in":"query","schema":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"description":"The object type to filter by"},{"name":"object","in":"query","schema":{"type":"string","example":"contact"},"description":"The object to filter by"},{"name":"entity_id","deprecated":true,"in":"query","schema":{"type":"string","example":"e74b5a4f-f252-4a6c-940c-f35873498543"},"description":"The entity id to filter by"}],"responses":{"200":{"description":"Sync","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous"],"title":"pagination"},{"type":"object","properties":{"results":{"type":"array","items":{"oneOf":[{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"971cb76d-9558-42fe-8f3b-8a531c32bd5f"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"object":{"type":"string","example":"contact"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false},"provider_name":{"type":"string","example":"hubspot"},"customer_id":{"type":"string","example":"my-customer-1"}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused","provider_name","customer_id"]},{"type":"object","title":"Data model: Entities","properties":{"id":{"type":"string","example":"971cb76d-9558-42fe-8f3b-8a531c32bd5f"},"type":{"type":"string","enum":["entity"],"example":"entity"},"entity_id":{"type":"string","example":"70da3830-b717-49cb-91f0-22fb3f09a97a"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false},"provider_name":{"type":"string","example":"hubspot"},"customer_id":{"type":"string","example":"my-customer-1"}},"required":["id","type","entity_id","connection_id","sync_config_id","paused","provider_name","customer_id"]}],"title":"sync_with_provider_and_customer"}}}}]}}}}},"method":"get","path":"/syncs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get Syncs","description":{"content":"Get a list of Syncs.","type":"text/plain"},"url":{"path":["syncs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"Number of results to return per page","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"customer_id","value":""},{"disabled":false,"description":{"content":"The provider name","type":"text/plain"},"key":"provider_name","value":""},{"disabled":false,"description":{"content":"The object type to filter by","type":"text/plain"},"key":"object_type","value":""},{"disabled":false,"description":{"content":"The object to filter by","type":"text/plain"},"key":"object","value":""},{"disabled":false,"description":{"content":"The entity id to filter by","type":"text/plain"},"key":"entity_id","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -34,9 +34,9 @@ Get a list of Syncs. ## Request -

    Query Parameters

    +

    Query Parameters

    Sync -
    Schema
      results object[]
    • Array [
      • oneOf
    • ]
    +
    Schema
      results object[]
    • Array [
      • oneOf
    • ]
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/pause-sync.api.mdx b/docs/docs/api/v2/mgmt/pause-sync.api.mdx index c22395845c..ce56adeb76 100644 --- a/docs/docs/api/v2/mgmt/pause-sync.api.mdx +++ b/docs/docs/api/v2/mgmt/pause-sync.api.mdx @@ -5,7 +5,7 @@ description: "Pause sync" sidebar_label: "Pause sync" hide_title: true hide_table_of_contents: true -api: {"operationId":"pauseSync","tags":["Syncs"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"entity_id":{"type":"string","description":"The entity id to filter by"}},"required":["entity_id"]},{"type":"object","title":"Data model: Objects","properties":{"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard","description":"The object type to filter by"},"object":{"type":"string","example":"Contact","description":"The Provider object to filter by (case sensitive)"}},"required":["object_type","object"]},{"type":"object","title":"Data model: Common Schema","properties":{"object_type":{"type":"string","enum":["common"],"example":"common","description":"The object type to filter by"},"object":{"type":"string","example":"contact","description":"The Supaglue object to filter by"}},"required":["object_type","object"]}]}}}},"responses":{"200":{"description":"Sync paused","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["entity"],"example":"entity"},"entity_id":{"type":"string","example":"94e6cb6c-0ec8-423f-8873-21054979a6b1"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","entity_id","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"object":{"type":"string","example":"contact","description":"The Provider's object name (case sensitive)"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Common Schema","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common"],"example":"standard"},"object":{"type":"string","example":"contact","description":"Supaglue's object name"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]}],"title":"sync"}}}}},"description":"Pause sync","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/syncs/_pause","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"entity_id":"string"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Pause sync","description":{"type":"text/plain"},"url":{"path":["syncs","_pause"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"pauseSync","tags":["Syncs"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Objects","properties":{"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard","description":"The object type to filter by"},"object":{"type":"string","example":"Contact","description":"The Provider object to filter by (case sensitive)"}},"required":["object_type","object"]},{"type":"object","title":"Data model: Common Schema","properties":{"object_type":{"type":"string","enum":["common"],"example":"common","description":"The object type to filter by"},"object":{"type":"string","example":"contact","description":"The Supaglue object to filter by"}},"required":["object_type","object"]},{"type":"object","title":"Data model: Entities","deprecated":true,"properties":{"entity_id":{"type":"string","description":"The entity id to filter by"}},"required":["entity_id"]}]}}}},"responses":{"200":{"description":"Sync paused","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"object":{"type":"string","example":"contact","description":"The Provider's object name (case sensitive)"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Common Schema","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common"],"example":"standard"},"object":{"type":"string","example":"contact","description":"Supaglue's object name"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Entities","deprecated":true,"properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["entity"],"example":"entity"},"entity_id":{"type":"string","example":"94e6cb6c-0ec8-423f-8873-21054979a6b1"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","entity_id","connection_id","sync_config_id","paused"]}],"title":"sync"}}}}},"description":"Pause sync","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/syncs/_pause","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"object_type":"standard","object":"Contact"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Pause sync","description":{"type":"text/plain"},"url":{"path":["syncs","_pause"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -34,9 +34,9 @@ Pause sync ## Request -

    Header Parameters

    Body

    required
      oneOf
    +

    Header Parameters

    Body

    required
      oneOf
    Sync paused -
    Schema
      oneOf
    +
    Schema
      oneOf
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/providers.tag.mdx b/docs/docs/api/v2/mgmt/providers.tag.mdx deleted file mode 100644 index fca488489d..0000000000 --- a/docs/docs/api/v2/mgmt/providers.tag.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: providers -title: "Providers" -description: "Providers" -custom_edit_url: null ---- - - - -A `Provider` is a third-party SaaS tool we can connect to (e.g. Salesforce). - - - -```mdx-code-block -import DocCardList from '@theme/DocCardList'; -import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; - - -``` - \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/resume-sync.api.mdx b/docs/docs/api/v2/mgmt/resume-sync.api.mdx index 29514ab2cf..d5a33206f3 100644 --- a/docs/docs/api/v2/mgmt/resume-sync.api.mdx +++ b/docs/docs/api/v2/mgmt/resume-sync.api.mdx @@ -5,7 +5,7 @@ description: "Resume sync" sidebar_label: "Resume sync" hide_title: true hide_table_of_contents: true -api: {"operationId":"resumeSync","tags":["Syncs"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"entity_id":{"type":"string","example":"cfba6060-c43a-4a63-8a8c-501c6099f8b0","description":"The entity id to filter by"}},"required":["entity_id"]},{"type":"object","title":"Data model: Objects","properties":{"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard","description":"The object type to filter by"},"object":{"type":"string","example":"contact","description":"The object to filter by"}},"required":["object_type","object"]}]}}}},"responses":{"200":{"description":"Sync resumed","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["entity"],"example":"entity"},"entity_id":{"type":"string","example":"94e6cb6c-0ec8-423f-8873-21054979a6b1"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","entity_id","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"object":{"type":"string","example":"contact","description":"The Provider's object name (case sensitive)"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Common Schema","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common"],"example":"standard"},"object":{"type":"string","example":"contact","description":"Supaglue's object name"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]}],"title":"sync"},"example":{"id":"2caab904-3c7c-4894-8c82-4c28913b3419","type":"entity","entity_id":"db602f88-7a8c-44f0-8932-c92f1e033494","connection_id":"da732713-2ff7-4f3b-8728-257a026177cd","sync_config_id":"f2b3ea2a-6a1e-4983-91f1-92a4db4d7abd","paused":false}}}}},"description":"Resume sync","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/syncs/_resume","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"entity_id":"cfba6060-c43a-4a63-8a8c-501c6099f8b0"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Resume sync","description":{"type":"text/plain"},"url":{"path":["syncs","_resume"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"resumeSync","tags":["Syncs"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Objects","properties":{"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard","description":"The object type to filter by"},"object":{"type":"string","example":"contact","description":"The object to filter by"}},"required":["object_type","object"]},{"type":"object","title":"Data model: Entities","deprecated":true,"properties":{"entity_id":{"type":"string","example":"cfba6060-c43a-4a63-8a8c-501c6099f8b0","description":"The entity id to filter by"}},"required":["entity_id"]}]}}}},"responses":{"200":{"description":"Sync resumed","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"object":{"type":"string","example":"contact","description":"The Provider's object name (case sensitive)"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Common Schema","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common"],"example":"standard"},"object":{"type":"string","example":"contact","description":"Supaglue's object name"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Entities","deprecated":true,"properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["entity"],"example":"entity"},"entity_id":{"type":"string","example":"94e6cb6c-0ec8-423f-8873-21054979a6b1"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","entity_id","connection_id","sync_config_id","paused"]}],"title":"sync"},"example":{"id":"2caab904-3c7c-4894-8c82-4c28913b3419","type":"entity","entity_id":"db602f88-7a8c-44f0-8932-c92f1e033494","connection_id":"da732713-2ff7-4f3b-8728-257a026177cd","sync_config_id":"f2b3ea2a-6a1e-4983-91f1-92a4db4d7abd","paused":false}}}}},"description":"Resume sync","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/syncs/_resume","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"object_type":"standard","object":"contact"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Resume sync","description":{"type":"text/plain"},"url":{"path":["syncs","_resume"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -34,9 +34,9 @@ Resume sync ## Request -

    Header Parameters

    Body

    required
      oneOf
    +

    Header Parameters

    Body

    required
      oneOf
    Sync resumed -
    Schema
      oneOf
    +
    Schema
      oneOf
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/sidebar.js b/docs/docs/api/v2/mgmt/sidebar.js index 98e0ede077..79e4436910 100644 --- a/docs/docs/api/v2/mgmt/sidebar.js +++ b/docs/docs/api/v2/mgmt/sidebar.js @@ -1 +1 @@ -module.exports = [{"type":"doc","id":"api/v2/mgmt/management-api"},{"type":"category","label":"Customers","link":{"type":"doc","id":"api/v2/mgmt/customers"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-customers","label":"List customers","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/upsert-customer","label":"Upsert customer","className":"api-method put"},{"type":"doc","id":"api/v2/mgmt/get-customer","label":"Get customer","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/delete-customer","label":"Delete customer","className":"api-method delete"}]},{"type":"category","label":"Connections","link":{"type":"doc","id":"api/v2/mgmt/connections"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-connections","label":"List connections","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/create-connection","label":"Create a connection","className":"api-method post"},{"type":"doc","id":"api/v2/mgmt/get-provider-user-id","label":"Get logged in User ID and details","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/get-connection","label":"Get connection","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/delete-connection","label":"Delete connection","className":"api-method delete"}]},{"type":"category","label":"ConnectionSyncConfigs","link":{"type":"doc","id":"api/v2/mgmt/connection-sync-configs"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-connection-sync-config","label":"Get connection sync config","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/upsert-connection-sync-config","label":"Upsert connection sync config","className":"api-method put"},{"type":"doc","id":"api/v2/mgmt/delete-connection-sync-config","label":"Delete connection sync config","className":"api-method delete"}]},{"type":"category","label":"Destinations","link":{"type":"doc","id":"api/v2/mgmt/destinations"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-destinations","label":"List destinations","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/create-destination","label":"Create destination","className":"api-method post"},{"type":"doc","id":"api/v2/mgmt/get-destination","label":"Get destination","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/update-destination","label":"Update destination","className":"api-method put"}]},{"type":"category","label":"Magic Links","link":{"type":"doc","id":"api/v2/mgmt/magic-links"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-magic-links","label":"List magic links","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/create-magic-link","label":"Create magic link","className":"api-method post"},{"type":"doc","id":"api/v2/mgmt/delete-magic-link","label":"Delete magic link","className":"api-method delete"}]},{"type":"category","label":"Providers","link":{"type":"doc","id":"api/v2/mgmt/providers"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-providers","label":"List providers","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/create-provider","label":"Create provider","className":"api-method post"},{"type":"doc","id":"api/v2/mgmt/get-provider","label":"Get provider","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/update-provider","label":"Update provider","className":"api-method put"},{"type":"doc","id":"api/v2/mgmt/delete-provider","label":"Delete provider","className":"api-method delete"}]},{"type":"category","label":"Schemas","link":{"type":"doc","id":"api/v2/mgmt/schemas"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-schemas","label":"List schemas","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/v2/mgmt/create-schema","label":"Create schema","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/v2/mgmt/get-schema","label":"Get schema","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/v2/mgmt/update-schema","label":"Update schema","className":"menu__list-item--deprecated api-method put"},{"type":"doc","id":"api/v2/mgmt/delete-schema","label":"Delete schema","className":"menu__list-item--deprecated api-method delete"}]},{"type":"category","label":"Entities","link":{"type":"doc","id":"api/v2/mgmt/entities"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-entities","label":"List entities","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/v2/mgmt/create-entity","label":"Create entity","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/v2/mgmt/get-entity","label":"Get entity","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/v2/mgmt/update-entity","label":"Update entity","className":"menu__list-item--deprecated api-method put"},{"type":"doc","id":"api/v2/mgmt/delete-entity","label":"Delete entity","className":"menu__list-item--deprecated api-method delete"}]},{"type":"category","label":"EntityMappings","link":{"type":"doc","id":"api/v2/mgmt/entity-mappings"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/list-entity-mappings","label":"List entity mappings.","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/v2/mgmt/upsert-entity-mapping","label":"Upsert entity mapping","className":"menu__list-item--deprecated api-method put"},{"type":"doc","id":"api/v2/mgmt/delete-entity-mapping","label":"Delete entity mapping","className":"menu__list-item--deprecated api-method delete"}]},{"type":"category","label":"SchemaMappings","link":{"type":"doc","id":"api/v2/mgmt/schema-mappings"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/list-field-mappings","label":"List schema mappings","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/v2/mgmt/update-object-field-mappings","label":"Update schema mappings","className":"menu__list-item--deprecated api-method put"}]},{"type":"category","label":"SyncConfigs","link":{"type":"doc","id":"api/v2/mgmt/sync-configs"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-sync-configs","label":"List Sync Configs","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/create-sync-config","label":"Create Sync Config","className":"api-method post"},{"type":"doc","id":"api/v2/mgmt/get-sync-config","label":"Get Sync Config","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/update-sync-config","label":"Update Sync Config","className":"api-method put"},{"type":"doc","id":"api/v2/mgmt/delete-sync-config","label":"Delete Sync Config","className":"api-method delete"}]},{"type":"category","label":"SyncRuns","link":{"type":"doc","id":"api/v2/mgmt/sync-runs"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-sync-runs","label":"Get SyncRuns","className":"api-method get"}]},{"type":"category","label":"Syncs","link":{"type":"doc","id":"api/v2/mgmt/syncs"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-syncs","label":"Get Syncs","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/pause-sync","label":"Pause sync","className":"api-method post"},{"type":"doc","id":"api/v2/mgmt/resume-sync","label":"Resume sync","className":"api-method post"},{"type":"doc","id":"api/v2/mgmt/trigger-sync","label":"Trigger sync","className":"api-method post"}]},{"type":"category","label":"Salesforce CDC Events (beta)","collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/salesforce-cdc-create","label":"Salesforce record created (beta)","className":"api-method event"},{"type":"doc","id":"api/v2/mgmt/salesforce-cdc-update","label":"Salesforce record updated (beta)","className":"api-method event"},{"type":"doc","id":"api/v2/mgmt/salesforce-cdc-delete","label":"Salesforce record deleted (beta)","className":"api-method event"},{"type":"doc","id":"api/v2/mgmt/salesforce-cdc-undelete","label":"Salesforce record undeleted (beta)","className":"api-method event"}]},{"type":"category","label":"Webhook Events","collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/sync-complete","label":"Sync complete","className":"api-method event"},{"type":"doc","id":"api/v2/mgmt/connection-created","label":"Customer connection created","className":"api-method event"},{"type":"doc","id":"api/v2/mgmt/connection-deleted","label":"Customer connection deleted","className":"api-method event"},{"type":"doc","id":"api/v2/mgmt/entity-entity-mapping-created","label":"Entity mapping created","className":"menu__list-item--deprecated api-method event"},{"type":"doc","id":"api/v2/mgmt/entity-entity-mapping-updated","label":"Entity mapping updated","className":"menu__list-item--deprecated api-method event"},{"type":"doc","id":"api/v2/mgmt/entity-entity-mapping-deleted","label":"Entity mapping deleted","className":"menu__list-item--deprecated api-method event"},{"type":"doc","id":"api/v2/mgmt/object-field-mapping-created","label":"Object field mapping created","className":"menu__list-item--deprecated api-method event"},{"type":"doc","id":"api/v2/mgmt/object-field-mapping-updated","label":"Object field mapping updated","className":"menu__list-item--deprecated api-method event"}]}]; \ No newline at end of file +module.exports = [{"type":"doc","id":"api/v2/mgmt/management-api"},{"type":"category","label":"Customers","link":{"type":"doc","id":"api/v2/mgmt/customers"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-customers","label":"List customers","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/upsert-customer","label":"Upsert customer","className":"api-method put"},{"type":"doc","id":"api/v2/mgmt/get-customer","label":"Get customer","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/delete-customer","label":"Delete customer","className":"api-method delete"}]},{"type":"category","label":"Connections","link":{"type":"doc","id":"api/v2/mgmt/connections"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-connections","label":"List connections","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/create-connection","label":"Create a connection","className":"api-method post"},{"type":"doc","id":"api/v2/mgmt/get-provider-user-id","label":"Get logged in User ID and details","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/get-connection","label":"Get connection","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/delete-connection","label":"Delete connection","className":"api-method delete"}]},{"type":"category","label":"ConnectionSyncConfigs","link":{"type":"doc","id":"api/v2/mgmt/connection-sync-configs"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-connection-sync-config","label":"Get connection sync config","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/upsert-connection-sync-config","label":"Upsert connection sync config","className":"api-method put"},{"type":"doc","id":"api/v2/mgmt/delete-connection-sync-config","label":"Delete connection sync config","className":"api-method delete"}]},{"type":"category","label":"Magic Links","link":{"type":"doc","id":"api/v2/mgmt/magic-links"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-magic-links","label":"List magic links","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/create-magic-link","label":"Create magic link","className":"api-method post"},{"type":"doc","id":"api/v2/mgmt/delete-magic-link","label":"Delete magic link","className":"api-method delete"}]},{"type":"category","label":"Schemas","link":{"type":"doc","id":"api/v2/mgmt/schemas"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-schemas","label":"List schemas","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/v2/mgmt/create-schema","label":"Create schema","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/v2/mgmt/get-schema","label":"Get schema","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/v2/mgmt/update-schema","label":"Update schema","className":"menu__list-item--deprecated api-method put"},{"type":"doc","id":"api/v2/mgmt/delete-schema","label":"Delete schema","className":"menu__list-item--deprecated api-method delete"}]},{"type":"category","label":"Entities","link":{"type":"doc","id":"api/v2/mgmt/entities"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-entities","label":"List entities","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/v2/mgmt/create-entity","label":"Create entity","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/v2/mgmt/get-entity","label":"Get entity","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/v2/mgmt/update-entity","label":"Update entity","className":"menu__list-item--deprecated api-method put"},{"type":"doc","id":"api/v2/mgmt/delete-entity","label":"Delete entity","className":"menu__list-item--deprecated api-method delete"}]},{"type":"category","label":"EntityMappings","link":{"type":"doc","id":"api/v2/mgmt/entity-mappings"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/list-entity-mappings","label":"List entity mappings.","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/v2/mgmt/upsert-entity-mapping","label":"Upsert entity mapping","className":"menu__list-item--deprecated api-method put"},{"type":"doc","id":"api/v2/mgmt/delete-entity-mapping","label":"Delete entity mapping","className":"menu__list-item--deprecated api-method delete"}]},{"type":"category","label":"SchemaMappings","link":{"type":"doc","id":"api/v2/mgmt/schema-mappings"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/list-field-mappings","label":"List schema mappings","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/v2/mgmt/update-object-field-mappings","label":"Update schema mappings","className":"menu__list-item--deprecated api-method put"}]},{"type":"category","label":"SyncConfigs","link":{"type":"doc","id":"api/v2/mgmt/sync-configs"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-sync-configs","label":"List Sync Configs","className":"api-method get"}]},{"type":"category","label":"SyncRuns","link":{"type":"doc","id":"api/v2/mgmt/sync-runs"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-sync-runs","label":"Get SyncRuns","className":"api-method get"}]},{"type":"category","label":"Syncs","link":{"type":"doc","id":"api/v2/mgmt/syncs"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-syncs","label":"Get Syncs","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/pause-sync","label":"Pause sync","className":"api-method post"},{"type":"doc","id":"api/v2/mgmt/resume-sync","label":"Resume sync","className":"api-method post"},{"type":"doc","id":"api/v2/mgmt/trigger-sync","label":"Trigger sync","className":"api-method post"}]},{"type":"category","label":"Salesforce CDC Events (beta)","collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/salesforce-cdc-create","label":"Salesforce record created (beta)","className":"api-method event"},{"type":"doc","id":"api/v2/mgmt/salesforce-cdc-update","label":"Salesforce record updated (beta)","className":"api-method event"},{"type":"doc","id":"api/v2/mgmt/salesforce-cdc-delete","label":"Salesforce record deleted (beta)","className":"api-method event"},{"type":"doc","id":"api/v2/mgmt/salesforce-cdc-undelete","label":"Salesforce record undeleted (beta)","className":"api-method event"}]},{"type":"category","label":"Webhook Events","collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/sync-complete","label":"Sync complete","className":"api-method event"},{"type":"doc","id":"api/v2/mgmt/connection-created","label":"Customer connection created","className":"api-method event"},{"type":"doc","id":"api/v2/mgmt/connection-deleted","label":"Customer connection deleted","className":"api-method event"},{"type":"doc","id":"api/v2/mgmt/entity-entity-mapping-created","label":"Entity mapping created","className":"menu__list-item--deprecated api-method event"},{"type":"doc","id":"api/v2/mgmt/entity-entity-mapping-updated","label":"Entity mapping updated","className":"menu__list-item--deprecated api-method event"},{"type":"doc","id":"api/v2/mgmt/entity-entity-mapping-deleted","label":"Entity mapping deleted","className":"menu__list-item--deprecated api-method event"},{"type":"doc","id":"api/v2/mgmt/object-field-mapping-created","label":"Object field mapping created","className":"menu__list-item--deprecated api-method event"},{"type":"doc","id":"api/v2/mgmt/object-field-mapping-updated","label":"Object field mapping updated","className":"menu__list-item--deprecated api-method event"}]}]; \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/trigger-sync.api.mdx b/docs/docs/api/v2/mgmt/trigger-sync.api.mdx index 282de95f6d..ca0ae17876 100644 --- a/docs/docs/api/v2/mgmt/trigger-sync.api.mdx +++ b/docs/docs/api/v2/mgmt/trigger-sync.api.mdx @@ -5,7 +5,7 @@ description: "Trigger sync" sidebar_label: "Trigger sync" hide_title: true hide_table_of_contents: true -api: {"operationId":"triggerSync","tags":["Syncs"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"entity_id":{"type":"string","description":"The entity id to filter by"},"perform_full_refresh":{"type":"boolean","example":true}},"required":["entity_id"]},{"type":"object","title":"Data model: Objects","properties":{"object_type":{"type":"string","enum":["standard","custom"],"description":"The object type to filter by","example":"standard"},"object":{"type":"string","example":"contact","description":"The Provider object to filter by (case sensitive)"},"perform_full_refresh":{"type":"boolean","example":true}},"required":["object_type","object"]},{"type":"object","title":"Data model: Common Schema","properties":{"object_type":{"type":"string","enum":["common"],"description":"The object type to filter by","example":"common"},"object":{"type":"string","example":"contact","description":"The Supaglue object to filter by"},"perform_full_refresh":{"type":"boolean","example":true}},"required":["object_type","object"]}]}}}},"responses":{"200":{"description":"Sync triggered","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["entity"],"example":"entity"},"entity_id":{"type":"string","example":"94e6cb6c-0ec8-423f-8873-21054979a6b1"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","entity_id","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"object":{"type":"string","example":"contact","description":"The Provider's object name (case sensitive)"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Common Schema","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common"],"example":"standard"},"object":{"type":"string","example":"contact","description":"Supaglue's object name"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]}],"title":"sync"}}}}},"description":"Trigger sync","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/syncs/_trigger","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"entity_id":"string","perform_full_refresh":true},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Trigger sync","description":{"type":"text/plain"},"url":{"path":["syncs","_trigger"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"triggerSync","tags":["Syncs"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Objects","properties":{"object_type":{"type":"string","enum":["standard","custom"],"description":"The object type to filter by","example":"standard"},"object":{"type":"string","example":"contact","description":"The Provider object to filter by (case sensitive)"},"perform_full_refresh":{"type":"boolean","example":true}},"required":["object_type","object"]},{"type":"object","title":"Data model: Common Schema","properties":{"object_type":{"type":"string","enum":["common"],"description":"The object type to filter by","example":"common"},"object":{"type":"string","example":"contact","description":"The Supaglue object to filter by"},"perform_full_refresh":{"type":"boolean","example":true}},"required":["object_type","object"]},{"type":"object","title":"Data model: Entities","deprecated":true,"properties":{"entity_id":{"type":"string","description":"The entity id to filter by"},"perform_full_refresh":{"type":"boolean","example":true}},"required":["entity_id"]}]}}}},"responses":{"200":{"description":"Sync triggered","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"object":{"type":"string","example":"contact","description":"The Provider's object name (case sensitive)"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Common Schema","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common"],"example":"standard"},"object":{"type":"string","example":"contact","description":"Supaglue's object name"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Entities","deprecated":true,"properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["entity"],"example":"entity"},"entity_id":{"type":"string","example":"94e6cb6c-0ec8-423f-8873-21054979a6b1"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","entity_id","connection_id","sync_config_id","paused"]}],"title":"sync"}}}}},"description":"Trigger sync","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/syncs/_trigger","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"object_type":"standard","object":"contact","perform_full_refresh":true},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Trigger sync","description":{"type":"text/plain"},"url":{"path":["syncs","_trigger"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -34,9 +34,9 @@ Trigger sync ## Request -

    Header Parameters

    Body

    required
      oneOf
    +

    Header Parameters

    Body

    required
      oneOf
    Sync triggered -
    Schema
      oneOf
    +
    Schema
      oneOf
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/update-destination.api.mdx b/docs/docs/api/v2/mgmt/update-destination.api.mdx deleted file mode 100644 index 2a86a48392..0000000000 --- a/docs/docs/api/v2/mgmt/update-destination.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: update-destination -title: "Update destination" -description: "Update destination" -sidebar_label: "Update destination" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"updateDestination","tags":["Destinations"],"parameters":[{"name":"destination_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser","password":"mysensitivepassword"}},"oneOf":[{"type":"object","title":"postgres","properties":{"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"password":{"type":"string","example":"mysensitivepassword"}},"required":["host","port","database","schema","user"],"title":"postgres_config_at_least_safe"},"version":{"type":"number","example":"number"}},"required":["name","type","config","version"]},{"type":"object","title":"bigquery","properties":{"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"},"private_key":{"type":"string","example":"-----BEGIN PRIVATE KEY-----\\nMII..."}},"required":["client_email","private_key"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_at_least_safe"},"version":{"type":"number","example":"number"}},"required":["name","type","config","version"]},{"type":"object","title":"mongodb","properties":{"name":{"type":"string","example":"My MongoDB Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"},"password":{"type":"string","example":"mysensitivepassword"}},"required":["host","database","user"],"title":"mongodb_config_at_least_safe"},"version":{"type":"number","example":"number"}},"required":["name","type","config","version"]}],"title":"update_destination"}}}},"responses":{"200":{"description":"Destination","content":{"application/json":{"schema":{"example":{"id":"2cce5aed-e8fc-41b2-bff6-6ddbc1f99285","application_id":"e52286c9-3038-4fa2-a2b8-3ec9759d20cb","name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser"}},"oneOf":[{"type":"object","title":"supaglue","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"type":{"type":"string","enum":["supaglue"],"example":"supaglue"},"version":{"type":"number"}},"required":["id","application_id","type","version"]},{"type":"object","title":"postgres","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"ssl_mode":{"type":"string","enum":["disable","allow","prefer","require"],"example":"disable"}},"required":["host","port","database","schema","user"],"title":"postgres_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"bigquery","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"}},"required":["client_email"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"mongodb","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My Mongo Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"}},"required":["host","database","user"],"title":"mongodb_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]}],"title":"destination"}}}}},"description":"Update destination","method":"put","path":"/destinations/{destination_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser","password":"mysensitivepassword"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update destination","description":{"type":"text/plain"},"url":{"path":["destinations",":destination_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"destination_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: api/v2/mgmt/management-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

    Update destination

    - - - - - - - -Update destination - -## Request - -

    Path Parameters

    Body

    required
      oneOf
      config objectrequired
      config objectrequired
      credentials objectrequired
      config objectrequired
    - -Destination - -
    Schema
      oneOf
      config objectrequired
      config objectrequired
      credentials objectrequired
      config objectrequired
    - \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/update-entity.api.mdx b/docs/docs/api/v2/mgmt/update-entity.api.mdx index 64baf966d2..8682322c7c 100644 --- a/docs/docs/api/v2/mgmt/update-entity.api.mdx +++ b/docs/docs/api/v2/mgmt/update-entity.api.mdx @@ -5,7 +5,7 @@ description: "Update entity" sidebar_label: "Update entity" hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"updateEntity","tags":["Entities"],"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["name","config"],"title":"create_update_entity"}}}},"responses":{"200":{"description":"Entity","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}},"description":"Update entity","method":"put","path":"/entities/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"my-entity","config":{"fields":[{"name":"apolla_first_name"}],"allow_additional_field_mappings":true}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update entity","description":{"type":"text/plain"},"url":{"path":["entities",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"deprecated":true,"operationId":"updateEntity","tags":["Entities"],"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"my-entity"},"config":{"type":"object","deprecated":true,"properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["name","config"],"title":"create_update_entity"}}}},"responses":{"200":{"description":"Entity","content":{"application/json":{"schema":{"type":"object","deprecated":true,"properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","deprecated":true,"properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}},"description":"Update entity","method":"put","path":"/entities/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"my-entity"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update entity","description":{"type":"text/plain"},"url":{"path":["entities",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -38,9 +38,9 @@ Update entity ## Request -

    Path Parameters

    Body

    required
      config objectrequired
      fields object[]required
    • Array [
    • ]
    +

    Path Parameters

    Body

    required
      config objectrequireddeprecated
      fields object[]required
    • Array [
    • ]
    Entity -
    Schema
      config objectrequired
      fields object[]required
    • Array [
    • ]
    +
    Schema
      config objectrequireddeprecated
      fields object[]required
    • Array [
    • ]
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/update-provider.api.mdx b/docs/docs/api/v2/mgmt/update-provider.api.mdx deleted file mode 100644 index bd473ef672..0000000000 --- a/docs/docs/api/v2/mgmt/update-provider.api.mdx +++ /dev/null @@ -1,78 +0,0 @@ ---- -id: update-provider -title: "Update provider" -description: "Update provider" -sidebar_label: "Update provider" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"updateProvider","tags":["Providers"],"parameters":[{"name":"provider_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"crm","properties":{"auth_type":{"type":"string","enum":["oauth2"]},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string"},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"}},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string"},"oauth_client_secret":{"type":"string"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"example":{"provider_app_id":"my_app_id","oauth":{"oauth_scopes":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"],"credentials":{"oauth_client_id":"7393b5a4-5e20-4648-87af-b7b297793fd1","oauth_client_secret":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}}},"title":"update_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}},"category":{"type":"string","enum":["crm"]},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule"],"title":"provider_name_crm"}},"required":["auth_type","config","category","name"]},{"type":"object","title":"engagement","properties":{"auth_type":{"type":"string","enum":["oauth2"]},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string"},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"}},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string"},"oauth_client_secret":{"type":"string"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"example":{"provider_app_id":"my_app_id","oauth":{"oauth_scopes":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"],"credentials":{"oauth_client_id":"7393b5a4-5e20-4648-87af-b7b297793fd1","oauth_client_secret":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}}},"title":"update_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}},"category":{"type":"string","enum":["engagement"]},"name":{"type":"string","enum":["outreach","apollo","salesloft"],"title":"provider_name_engagement"}},"required":["auth_type","config","category","name"]},{"type":"object","title":"no category","properties":{"auth_type":{"type":"string","enum":["oauth2"]},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string"},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"}},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string"},"oauth_client_secret":{"type":"string"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"example":{"provider_app_id":"my_app_id","oauth":{"oauth_scopes":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"],"credentials":{"oauth_client_id":"7393b5a4-5e20-4648-87af-b7b297793fd1","oauth_client_secret":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}}},"title":"update_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}},"category":{"type":"string","enum":["no_category"]},"name":{"type":"string","enum":["intercom","gong","linear"],"title":"provider_name_no_category"}},"required":["auth_type","config","category","name"]}],"title":"update_provider"}}}},"responses":{"200":{"description":"Provider","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"0c4cb91f-e392-46f5-8934-17496371f932"},"application_id":{"type":"string","example":"273e1c75-3b6d-439a-9b8e-c6ac407df92a"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"auth_type":{"type":"string","enum":["oauth2","api_key"],"example":"oauth2"},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement","slack"],"example":"hubspot","title":"provider_name"},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers.","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}}},"required":["id","application_id","category","auth_type","name"],"title":"provider"}}}}},"description":"Update provider","method":"put","path":"/providers/{provider_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"auth_type":"oauth2","config":{"provider_app_id":"my_app_id","oauth":{"oauth_scopes":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"],"credentials":{"oauth_client_id":"7393b5a4-5e20-4648-87af-b7b297793fd1","oauth_client_secret":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}}},"objects":{"common":[{"name":"account","schema_id":"328a8cb3-8345-4b02-b661-ee13b4f76806"}],"standard":[{"name":"Account","schema_id":"777ea826-5776-4347-9ece-47bbb17ccdd4"}]},"entity_mappings":[{"entity_id":"apolla_contact","object":{"type":"standard","name":"Contact"},"field_mappings":[{"entity_field":"apolla_first_name","mapped_field":"FirstName"}]}],"category":"crm","name":"hubspot"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update provider","description":{"type":"text/plain"},"url":{"path":["providers",":provider_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"provider_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: api/v2/mgmt/management-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

    Update provider

    - - - - - - - -Update provider - -## Request - -

    Path Parameters

    Body

    required
      oneOf
      config objectrequired
      - -An object that stores Oauth2/API key/access key related credentials. - -
      oauth objectrequired
      credentials objectrequired
      objects object
      - -This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers. - -
      common object[]
    • Array [
    • ]
      • standard object[]
    • Array [
    • ]
      • entity_mappings object[]
    • Array [
      • object object
      field_mappings object[]
    • Array [
    • ]
    • ]
      • config objectrequired
      - -An object that stores Oauth2/API key/access key related credentials. - -
      oauth objectrequired
      credentials objectrequired
      objects object
      - -This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers. - -
      common object[]
    • Array [
    • ]
      • standard object[]
    • Array [
    • ]
      • entity_mappings object[]
    • Array [
      • object object
      field_mappings object[]
    • Array [
    • ]
    • ]
      • config objectrequired
      - -An object that stores Oauth2/API key/access key related credentials. - -
      oauth objectrequired
      credentials objectrequired
      objects object
      - -This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers. - -
      common object[]
    • Array [
    • ]
      • standard object[]
    • Array [
    • ]
      • entity_mappings object[]
    • Array [
      • object object
      field_mappings object[]
    • Array [
    • ]
    • ]
    - -Provider - -
    Schema
      config object
      - -An object that stores Oauth2/API key/access key related credentials. - -
      oauth objectrequired
      credentials objectrequired
      objects object
      - -This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers. - -
      common object[]
    • Array [
    • ]
      • standard object[]
    • Array [
    • ]
      • entity_mappings object[]
      - -This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers. - -
    • Array [
      • object object
      field_mappings object[]
    • Array [
    • ]
    • ]
    - \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/update-schema.api.mdx b/docs/docs/api/v2/mgmt/update-schema.api.mdx index 7dbe555733..ce4cc373ab 100644 --- a/docs/docs/api/v2/mgmt/update-schema.api.mdx +++ b/docs/docs/api/v2/mgmt/update-schema.api.mdx @@ -5,7 +5,7 @@ description: "Update schema" sidebar_label: "Update schema" hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"updateSchema","tags":["Schemas"],"parameters":[{"name":"schema_id","in":"path","required":true,"schema":{"type":"string","example":"a821d59d-8b4c-4ad9-aeec-1292d2e28701"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["name","config"],"title":"create_update_schema"}}}},"responses":{"200":{"description":"Schema","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}},"description":"Update schema","method":"put","path":"/schemas/{schema_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"my-schema","config":{"fields":[{"name":"apolla_first_name","mapped_name":"FirstName"}],"allow_additional_field_mappings":false}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update schema","description":{"type":"text/plain"},"url":{"path":["schemas",":schema_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"schema_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"deprecated":true,"operationId":"updateSchema","tags":["Schemas"],"parameters":[{"name":"schema_id","in":"path","required":true,"schema":{"type":"string","example":"a821d59d-8b4c-4ad9-aeec-1292d2e28701"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"my-schema"},"config":{"type":"object","deprecated":true,"properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["name","config"],"title":"create_update_schema"}}}},"responses":{"200":{"description":"Schema","content":{"application/json":{"schema":{"type":"object","deprecated":true,"properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","deprecated":true,"properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}},"description":"Update schema","method":"put","path":"/schemas/{schema_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"my-schema"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update schema","description":{"type":"text/plain"},"url":{"path":["schemas",":schema_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"schema_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -38,9 +38,9 @@ Update schema ## Request -

    Path Parameters

    Body

    required
      config objectrequired
      fields object[]required
    • Array [
    • ]
    +

    Path Parameters

    Body

    required
      config objectrequireddeprecated
      fields object[]required
    • Array [
    • ]
    Schema -
    Schema
      config objectrequired
      fields object[]required
    • Array [
    • ]
    +
    Schema
      config objectrequireddeprecated
      fields object[]required
    • Array [
    • ]
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/update-sync-config.api.mdx b/docs/docs/api/v2/mgmt/update-sync-config.api.mdx deleted file mode 100644 index 0d46a839be..0000000000 --- a/docs/docs/api/v2/mgmt/update-sync-config.api.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -id: update-sync-config -title: "Update Sync Config" -description: "Update Sync Config" -sidebar_label: "Update Sync Config" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"updateSyncConfig","tags":["SyncConfigs"],"parameters":[{"name":"sync_config_id","in":"path","required":true,"schema":{"type":"string","example":"d583ec72-55d4-4f35-9668-f6c759674cc1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["destination_id","provider_id","config"],"title":"create_update_sync_config"}}}},"responses":{"200":{"description":"SyncConfig","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}},"description":"Update Sync Config","method":"put","path":"/sync_configs/{sync_config_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"destination_id":"6e7baa88-84dd-4dbc-902a-14522c2984eb","provider_id":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af","config":{"default_config":{"period_ms":60000,"strategy":"full then incremental","auto_start_on_connection":true},"common_objects":[{"object":"contact"}],"standard_objects":[{"object":"Contact"}],"entities":[{"entity_id":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}]}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update Sync Config","description":{"type":"text/plain"},"url":{"path":["sync_configs",":sync_config_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"sync_config_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: api/v2/mgmt/management-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

    Update Sync Config

    - - - - - - - -Update Sync Config - -## Request - -

    Path Parameters

    Body

    required
      config objectrequired
      default_config objectrequired
      - -Configuration options for "how" to sync. - -
      = 60000`"} schema={{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."}}>
      common_objects object[]
      - -A list of Supaglue objects to be synced. - -
    • Array [
    • ]
      • standard_objects object[]
      - -A list of case-sensitive Provider objects to be synced. - -
    • Array [
    • ]
      • entities object[]
    • Array [
    • ]
    - -SyncConfig - -
    Schema
      config objectrequired
      default_config objectrequired
      - -Configuration options for "how" to sync. - -
      = 60000`"} schema={{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."}}>
      common_objects object[]
      - -A list of Supaglue objects to be synced. - -
    • Array [
    • ]
      • standard_objects object[]
      - -A list of case-sensitive Provider objects to be synced. - -
    • Array [
    • ]
      • entities object[]
    • Array [
    • ]
    - \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/upsert-customer.api.mdx b/docs/docs/api/v2/mgmt/upsert-customer.api.mdx index 61aa39d7b9..3d2492d103 100644 --- a/docs/docs/api/v2/mgmt/upsert-customer.api.mdx +++ b/docs/docs/api/v2/mgmt/upsert-customer.api.mdx @@ -5,7 +5,7 @@ description: "Upsert customer" sidebar_label: "Upsert customer" hide_title: true hide_table_of_contents: true -api: {"operationId":"upsertCustomer","tags":["Customers"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"}},"required":["name","email","customer_id"],"title":"create_update_customer"}}}},"responses":{"200":{"description":"Customer upserted","content":{"application/json":{"schema":{"type":"object","properties":{"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"},"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement","slack"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}},"required":["application_id","name","email","customer_id"],"title":"customer"}}}}},"description":"Upsert customer","method":"put","path":"/customers","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"customer_id":"your-customers-unique-application-id","name":"MyCompany Inc","email":"contact@mycompany.com"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Upsert customer","description":{"type":"text/plain"},"url":{"path":["customers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"upsertCustomer","tags":["Customers"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"}},"required":["name","email","customer_id"],"title":"create_update_customer"}}}},"responses":{"200":{"description":"Customer upserted","content":{"application/json":{"schema":{"type":"object","properties":{"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"},"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement","slack"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","deprecated":true,"properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","deprecated":true,"items":{"type":"object","deprecated":true,"properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","deprecated":true,"properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]},"connection_sync_config":{"type":"object","properties":{"destination_config":{"description":"An object to override the default Destination configuration per connection.","oneOf":[{"description":"Config specific to Postgres destination","type":"object","title":"Postgres","properties":{"type":{"type":"string","enum":["postgres"]},"schema":{"type":"string","description":"The schema you'd like to sync to. This schema must already exist. Supaglue will not create it. If not specified, the schema specified in the Postgres Destination will be used.","example":"customer_1_schema"}},"required":["type","schema"]},{"description":"Config specific to BigQuery destination","type":"object","title":"BigQuery","properties":{"type":{"type":"string","enum":["bigquery"]},"dataset":{"type":"string","description":"The dataset you'd like to sync to. This dataset must already exist. Supaglue will not create it. If not specified, the dataset specified in the BigQuery Destination will be used.","example":"customer_1_dataset"}},"required":["type","dataset"]},{"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nConfig specific to MongoDB destination\n","type":"object","title":"MongoDB (Preview)","properties":{"type":{"type":"string","enum":["mongodb"]},"collection":{"type":"string","description":"The collection you'd like to sync to. This collection must already exist. Supaglue will not create it. If not specified, the schema specified in the MongoDB Destination will be used.","example":"customer_1_schema"}},"required":["type","collection"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig.","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default collection used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}},"custom_objects":{"description":"(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig.\n","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default table used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}}},"title":"connection_sync_config"}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}},"required":["application_id","name","email","customer_id"],"title":"customer"}}}}},"description":"Upsert customer","method":"put","path":"/customers","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"customer_id":"your-customers-unique-application-id","name":"MyCompany Inc","email":"contact@mycompany.com"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Upsert customer","description":{"type":"text/plain"},"url":{"path":["customers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "put api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -38,13 +38,26 @@ Upsert customer Customer upserted -
    Schema
      connections object[]
    • Array [
      • schema_mappings_config object
      +
      Schema
        connections object[]
      • Array [
        • schema_mappings_config objectdeprecated
        This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings). -
        common_objects object[]
      • Array [
        • field_mappings object[]required
      • Array [
      • ]
      • ]
        • standard_objects object[]
      • Array [
        • field_mappings object[]required
      • Array [
      • ]
      • ]
        • entity_mappings object[]
        +
        common_objects object[]
      • Array [
        • field_mappings object[]required
      • Array [
      • ]
      • ]
        • standard_objects object[]
      • Array [
        • field_mappings object[]required
      • Array [
      • ]
      • ]
        • entity_mappings object[]deprecated
        This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping). -
      • Array [
        • object object
        field_mappings object[]
      • Array [
      • ]
      • ]
      • ]
      +
  • Array [
    • object object
    field_mappings object[]
  • Array [
  • ]
  • ]
    • connection_sync_config object
    destination_config object
    + +An object to override the default Destination configuration per connection. + +
    oneOf
    standard_objects object[]
    + +A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig. + +
  • Array [
    • oneOf
  • ]
    • custom_objects object[]
    + +(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig. + + +
  • Array [
    • oneOf
  • ]
  • ]
    • \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/upsert-entity-mapping.api.mdx b/docs/docs/api/v2/mgmt/upsert-entity-mapping.api.mdx index 2ef654107c..0e309b58f1 100644 --- a/docs/docs/api/v2/mgmt/upsert-entity-mapping.api.mdx +++ b/docs/docs/api/v2/mgmt/upsert-entity-mapping.api.mdx @@ -5,7 +5,7 @@ description: "Upsert entity mapping" sidebar_label: "Upsert entity mapping" hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"upsertEntityMapping","tags":["EntityMappings"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"}}}},"responses":{"200":{"description":"Entity Mapping"}},"description":"Upsert entity mapping","method":"put","path":"/entity_mappings/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"entity_id":"string","object":{"type":"standard","name":"string"},"field_mappings":[{"entity_field":"apolla_first_name","mapped_field":"FirstName"}]},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Upsert entity mapping","description":{"type":"text/plain"},"url":{"path":["entity_mappings",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"deprecated":true,"operationId":"upsertEntityMapping","tags":["EntityMappings"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","deprecated":true,"properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","deprecated":true,"properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"}}}},"responses":{"200":{"description":"Entity Mapping"}},"description":"Upsert entity mapping","method":"put","path":"/entity_mappings/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"entity_id":"string","object":{"type":"standard","name":"string"},"field_mappings":[{"entity_field":"apolla_first_name","mapped_field":"FirstName"}]},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Upsert entity mapping","description":{"type":"text/plain"},"url":{"path":["entity_mappings",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/openapi/v2/mgmt/components/schemas/create_destination.yaml b/openapi/v2/mgmt/components/schemas/create_destination.yaml index fdb293b26e..f40c97991b 100644 --- a/openapi/v2/mgmt/components/schemas/create_destination.yaml +++ b/openapi/v2/mgmt/components/schemas/create_destination.yaml @@ -1,14 +1,4 @@ oneOf: - - type: object - title: postgres - properties: - type: - type: string - enum: - - supaglue - example: supaglue - required: - - type - type: object title: postgres properties: @@ -26,6 +16,17 @@ oneOf: - name - type - config + - type: object + title: supaglue + description: A Supaglue-hosted Postgres database destination for Listing APIs. + properties: + type: + type: string + enum: + - supaglue + example: supaglue + required: + - type - type: object title: bigquery properties: diff --git a/openapi/v2/mgmt/components/schemas/objects/connection.yaml b/openapi/v2/mgmt/components/schemas/objects/connection.yaml index e3ab879643..e6062d05eb 100644 --- a/openapi/v2/mgmt/components/schemas/objects/connection.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/connection.yaml @@ -24,6 +24,8 @@ properties: $ref: ./schema_mappings_config.yaml entity_mappings: $ref: ./connection_entity_mappings.yaml + connection_sync_config: + $ref: ./connection_sync_config.yaml required: - id - application_id diff --git a/openapi/v2/mgmt/components/schemas/objects/connection_entity_mapping.yaml b/openapi/v2/mgmt/components/schemas/objects/connection_entity_mapping.yaml index 3613395f50..43c1e461c8 100644 --- a/openapi/v2/mgmt/components/schemas/objects/connection_entity_mapping.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/connection_entity_mapping.yaml @@ -1,4 +1,5 @@ type: object +deprecated: true properties: entity_id: type: string @@ -7,6 +8,6 @@ properties: field_mappings: type: array items: - $ref: ./entity_field_mapping.yaml + $ref: ./entity_field_mapping.yaml required: - entity_id diff --git a/openapi/v2/mgmt/components/schemas/objects/connection_entity_mappings.yaml b/openapi/v2/mgmt/components/schemas/objects/connection_entity_mappings.yaml index 3698cc62c2..d0300b32a9 100644 --- a/openapi/v2/mgmt/components/schemas/objects/connection_entity_mappings.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/connection_entity_mappings.yaml @@ -1,5 +1,6 @@ type: array description: This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping). +deprecated: true items: $ref: ./connection_entity_mapping.yaml example: [] diff --git a/openapi/v2/mgmt/components/schemas/objects/customer.yaml b/openapi/v2/mgmt/components/schemas/objects/customer.yaml index 4698c8fabe..2910d33598 100644 --- a/openapi/v2/mgmt/components/schemas/objects/customer.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/customer.yaml @@ -1,3 +1,4 @@ +# Supaglue Customer with connections type: object properties: application_id: diff --git a/openapi/v2/mgmt/components/schemas/objects/destination.yaml b/openapi/v2/mgmt/components/schemas/objects/destination.yaml index 10466ff3c2..f276507db0 100644 --- a/openapi/v2/mgmt/components/schemas/objects/destination.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/destination.yaml @@ -12,7 +12,7 @@ example: user: myuser oneOf: - type: object - title: supaglue + title: postgres properties: id: type: string @@ -20,20 +20,30 @@ oneOf: application_id: type: string example: 726fb798-d854-4c59-9a23-57e3e2f73eae + name: + type: string + example: My Postgres Destination type: type: string enum: - - supaglue - example: supaglue + - postgres + example: postgres + config: + $ref: ./postgres_config_safe.yaml version: type: number + example: 1 + description: A monotonically increasing version number of the destination configuration required: - id - application_id + - name - type + - config - version - type: object - title: postgres + title: supaglue + description: A Supaglue-hosted Postgres database destination for Listing APIs. properties: id: type: string @@ -41,24 +51,19 @@ oneOf: application_id: type: string example: 726fb798-d854-4c59-9a23-57e3e2f73eae - name: - type: string - example: My Postgres Destination type: type: string enum: - - postgres - example: postgres - config: - $ref: ./postgres_config_safe.yaml + - supaglue + example: supaglue version: type: number + example: 1 + description: A monotonically increasing version number of the destination configuration required: - id - application_id - - name - type - - config - version - type: object title: bigquery @@ -81,6 +86,8 @@ oneOf: $ref: ./bigquery_config_safe.yaml version: type: number + example: 1 + description: A monotonically increasing version number of the destination configuration required: - id - application_id @@ -109,6 +116,8 @@ oneOf: $ref: ./mongodb_config_safe.yaml version: type: number + example: 1 + description: A monotonically increasing version number of the destination configuration required: - id - application_id diff --git a/openapi/v2/mgmt/components/schemas/objects/entity.yaml b/openapi/v2/mgmt/components/schemas/objects/entity.yaml index cd9b6df10b..4b9e9061fb 100644 --- a/openapi/v2/mgmt/components/schemas/objects/entity.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/entity.yaml @@ -1,4 +1,5 @@ type: object +deprecated: true properties: id: type: string diff --git a/openapi/v2/mgmt/components/schemas/objects/entity_config.yaml b/openapi/v2/mgmt/components/schemas/objects/entity_config.yaml index d29ade6ae6..b135fc9888 100644 --- a/openapi/v2/mgmt/components/schemas/objects/entity_config.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/entity_config.yaml @@ -1,4 +1,5 @@ type: object +deprecated: true properties: fields: type: array diff --git a/openapi/v2/mgmt/components/schemas/objects/entity_field_mapping.yaml b/openapi/v2/mgmt/components/schemas/objects/entity_field_mapping.yaml index 9227c65a57..b4099b81f6 100644 --- a/openapi/v2/mgmt/components/schemas/objects/entity_field_mapping.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/entity_field_mapping.yaml @@ -1,4 +1,5 @@ type: object +deprecated: true properties: entity_field: type: string diff --git a/openapi/v2/mgmt/components/schemas/objects/magic_link.yaml b/openapi/v2/mgmt/components/schemas/objects/magic_link.yaml index a70e13a6d6..482006a4b6 100644 --- a/openapi/v2/mgmt/components/schemas/objects/magic_link.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/magic_link.yaml @@ -5,7 +5,10 @@ properties: example: ec208408-db29-4705-b39e-4d33070b4ef6 status: type: string - example: created + enum: + - new + - consumed + example: new application_id: type: string example: d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69 @@ -29,6 +32,7 @@ properties: type: string format: date-time example: '2023-02-23T00:00:00Z' + description: Any ISO formatted date-time string indicating when the magic link expires. required: - id - status diff --git a/openapi/v2/mgmt/components/schemas/objects/provider.yaml b/openapi/v2/mgmt/components/schemas/objects/provider.yaml index de56bf796a..3ea3ab3b4a 100644 --- a/openapi/v2/mgmt/components/schemas/objects/provider.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/provider.yaml @@ -13,6 +13,7 @@ properties: enum: - oauth2 - api_key + - access_key_secret example: oauth2 name: $ref: ./provider_name.yaml diff --git a/openapi/v2/mgmt/components/schemas/objects/provider_entity_mapping.yaml b/openapi/v2/mgmt/components/schemas/objects/provider_entity_mapping.yaml index 16a081d365..0074ceb601 100644 --- a/openapi/v2/mgmt/components/schemas/objects/provider_entity_mapping.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/provider_entity_mapping.yaml @@ -1,4 +1,5 @@ type: object +deprecated: true properties: entity_id: type: string diff --git a/openapi/v2/mgmt/components/schemas/objects/provider_entity_mappings.yaml b/openapi/v2/mgmt/components/schemas/objects/provider_entity_mappings.yaml index 61d5f01872..885062de8c 100644 --- a/openapi/v2/mgmt/components/schemas/objects/provider_entity_mappings.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/provider_entity_mappings.yaml @@ -1,4 +1,5 @@ type: array +deprecated: true description: This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers. items: $ref: ./provider_entity_mapping.yaml diff --git a/openapi/v2/mgmt/components/schemas/objects/s3_config_at_least_safe.yaml b/openapi/v2/mgmt/components/schemas/objects/s3_config_at_least_safe.yaml deleted file mode 100644 index 769ac01bc5..0000000000 --- a/openapi/v2/mgmt/components/schemas/objects/s3_config_at_least_safe.yaml +++ /dev/null @@ -1,18 +0,0 @@ -type: object -properties: - region: - type: string - example: us-west-2 - bucket: - type: string - example: my-test-bucket - access_key_id: - type: string - example: AKIAIOSFODNN7EXAMPLE - secret_access_key: - type: string - example: A1lciPB09K2iqNHTLAftxTHy0SKGxNcO4QecAsZS -required: - - region - - bucket - - access_key_id diff --git a/openapi/v2/mgmt/components/schemas/objects/s3_config_safe.yaml b/openapi/v2/mgmt/components/schemas/objects/s3_config_safe.yaml deleted file mode 100644 index a00a342e93..0000000000 --- a/openapi/v2/mgmt/components/schemas/objects/s3_config_safe.yaml +++ /dev/null @@ -1,15 +0,0 @@ -type: object -properties: - region: - type: string - example: us-west-2 - bucket: - type: string - example: my-test-bucket - access_key_id: - type: string - example: AKIAIOSFODNN7EXAMPLE -required: - - region - - bucket - - access_key_id diff --git a/openapi/v2/mgmt/components/schemas/objects/s3_config_unsafe.yaml b/openapi/v2/mgmt/components/schemas/objects/s3_config_unsafe.yaml deleted file mode 100644 index 52c27063f4..0000000000 --- a/openapi/v2/mgmt/components/schemas/objects/s3_config_unsafe.yaml +++ /dev/null @@ -1,19 +0,0 @@ -type: object -properties: - region: - type: string - example: us-west-2 - bucket: - type: string - example: my-test-bucket - access_key_id: - type: string - example: AKIAIOSFODNN7EXAMPLE - secret_access_key: - type: string - example: A1lciPB09K2iqNHTLAftxTHy0SKGxNcO4QecAsZS -required: - - region - - bucket - - access_key_id - - secret_access_key diff --git a/openapi/v2/mgmt/components/schemas/objects/schema.yaml b/openapi/v2/mgmt/components/schemas/objects/schema.yaml index ea11b278cf..91bf5bbf55 100644 --- a/openapi/v2/mgmt/components/schemas/objects/schema.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/schema.yaml @@ -1,4 +1,5 @@ type: object +deprecated: true properties: id: type: string diff --git a/openapi/v2/mgmt/components/schemas/objects/schema_config.yaml b/openapi/v2/mgmt/components/schemas/objects/schema_config.yaml index 87dc8aa60c..a59c8c41ee 100644 --- a/openapi/v2/mgmt/components/schemas/objects/schema_config.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/schema_config.yaml @@ -1,4 +1,5 @@ type: object +deprecated: true properties: fields: type: array diff --git a/openapi/v2/mgmt/components/schemas/objects/schema_mappings_config.yaml b/openapi/v2/mgmt/components/schemas/objects/schema_mappings_config.yaml index dc4ce86ec5..d37cdcbdfd 100644 --- a/openapi/v2/mgmt/components/schemas/objects/schema_mappings_config.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/schema_mappings_config.yaml @@ -1,5 +1,6 @@ description: This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings). type: object +deprecated: true properties: common_objects: type: array diff --git a/openapi/v2/mgmt/components/schemas/objects/simple_customer.yaml b/openapi/v2/mgmt/components/schemas/objects/simple_customer.yaml new file mode 100644 index 0000000000..d3a99b452b --- /dev/null +++ b/openapi/v2/mgmt/components/schemas/objects/simple_customer.yaml @@ -0,0 +1,19 @@ +type: object +properties: + application_id: + type: string + example: d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69 + customer_id: + type: string + example: your-customers-unique-application-id + name: + type: string + example: MyCompany Inc + email: + type: string + example: contact@mycompany.com +required: + - application_id + - name + - email + - customer_id diff --git a/openapi/v2/mgmt/components/schemas/objects/sync.yaml b/openapi/v2/mgmt/components/schemas/objects/sync.yaml index 80eea61cc3..25aa7757f7 100644 --- a/openapi/v2/mgmt/components/schemas/objects/sync.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/sync.yaml @@ -1,7 +1,7 @@ # this is verbose because our docs generator can't handle allOf with nested oneOf correctly oneOf: - type: object - title: 'Data model: Entities' + title: 'Data model: Objects' properties: id: type: string @@ -9,11 +9,19 @@ oneOf: type: type: string enum: - - entity - example: entity - entity_id: + - object + example: object + object_type: type: string - example: 94e6cb6c-0ec8-423f-8873-21054979a6b1 + enum: + - common + - standard + - custom + example: standard + object: + type: string + example: contact + description: The Provider's object name (case sensitive) connection_id: type: string example: 3217ea51-11c8-43c9-9547-6f197e02e5e4 @@ -26,12 +34,13 @@ oneOf: required: - id - type - - entity_id + - object_type + - object - connection_id - sync_config_id - paused - type: object - title: 'Data model: Objects' + title: 'Data model: Common Schema' properties: id: type: string @@ -45,13 +54,11 @@ oneOf: type: string enum: - common - - standard - - custom example: standard object: type: string example: contact - description: The Provider's object name (case sensitive) + description: Supaglue's object name connection_id: type: string example: 3217ea51-11c8-43c9-9547-6f197e02e5e4 @@ -70,7 +77,8 @@ oneOf: - sync_config_id - paused - type: object - title: 'Data model: Common Schema' + title: 'Data model: Entities' + deprecated: true properties: id: type: string @@ -78,17 +86,11 @@ oneOf: type: type: string enum: - - object - example: object - object_type: - type: string - enum: - - common - example: standard - object: + - entity + example: entity + entity_id: type: string - example: contact - description: Supaglue's object name + example: 94e6cb6c-0ec8-423f-8873-21054979a6b1 connection_id: type: string example: 3217ea51-11c8-43c9-9547-6f197e02e5e4 @@ -101,8 +103,7 @@ oneOf: required: - id - type - - object_type - - object + - entity_id - connection_id - sync_config_id - paused diff --git a/openapi/v2/mgmt/components/schemas/objects/sync_config_data.yaml b/openapi/v2/mgmt/components/schemas/objects/sync_config_data.yaml index ee8adc65f3..2b87adfcc0 100644 --- a/openapi/v2/mgmt/components/schemas/objects/sync_config_data.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/sync_config_data.yaml @@ -49,6 +49,7 @@ properties: - object entities: type: array + deprecated: true items: type: object properties: diff --git a/openapi/v2/mgmt/components/schemas/objects/sync_run.yaml b/openapi/v2/mgmt/components/schemas/objects/sync_run.yaml index 8337052e6d..30be38a404 100644 --- a/openapi/v2/mgmt/components/schemas/objects/sync_run.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/sync_run.yaml @@ -2,6 +2,12 @@ oneOf: - type: object title: 'Data model: Objects' properties: + id: + type: string + example: 20eb4da3-6b38-4ec6-a82d-ecee59a9d6d9 + sync_id: + type: string + example: 629525f8-f6f7-436c-80fa-1cb23acc5bf8 object_type: type: string enum: @@ -44,6 +50,8 @@ oneOf: nullable: true example: 100 required: + - id + - sync_id - object_type - object - start_timestamp @@ -58,9 +66,17 @@ oneOf: - num_records_synced - type: object title: 'Data model: Entities' + deprecated: true properties: + id: + type: string + example: 20eb4da3-6b38-4ec6-a82d-ecee59a9d6d9 + sync_id: + type: string + example: 629525f8-f6f7-436c-80fa-1cb23acc5bf8 entity_id: type: string + deprecated: true error_message: type: string nullable: true @@ -95,6 +111,8 @@ oneOf: nullable: true example: 100 required: + - id + - sync_id - entity_id - start_timestamp - end_timestamp diff --git a/openapi/v2/mgmt/components/schemas/objects/sync_with_provider_and_customer.yaml b/openapi/v2/mgmt/components/schemas/objects/sync_with_provider_and_customer.yaml index 29ab482762..cec6a7ee87 100644 --- a/openapi/v2/mgmt/components/schemas/objects/sync_with_provider_and_customer.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/sync_with_provider_and_customer.yaml @@ -1,7 +1,7 @@ # this is verbose because our docs generator can't handle allOf with nested oneOf correctly oneOf: - type: object - title: 'Data model: Entities' + title: 'Data model: Objects' properties: id: type: string @@ -9,11 +9,18 @@ oneOf: type: type: string enum: - - entity - example: entity - entity_id: + - object + example: object + object_type: type: string - example: 70da3830-b717-49cb-91f0-22fb3f09a97a + enum: + - common + - standard + - custom + example: standard + object: + type: string + example: contact connection_id: type: string example: 3217ea51-11c8-43c9-9547-6f197e02e5e4 @@ -32,14 +39,15 @@ oneOf: required: - id - type - - entity_id + - object_type + - object - connection_id - sync_config_id - paused - provider_name - customer_id - type: object - title: 'Data model: Objects' + title: 'Data model: Entities' properties: id: type: string @@ -47,18 +55,11 @@ oneOf: type: type: string enum: - - object - example: object - object_type: - type: string - enum: - - common - - standard - - custom - example: standard - object: + - entity + example: entity + entity_id: type: string - example: contact + example: 70da3830-b717-49cb-91f0-22fb3f09a97a connection_id: type: string example: 3217ea51-11c8-43c9-9547-6f197e02e5e4 @@ -77,8 +78,7 @@ oneOf: required: - id - type - - object_type - - object + - entity_id - connection_id - sync_config_id - paused diff --git a/openapi/v2/mgmt/openapi.bundle.json b/openapi/v2/mgmt/openapi.bundle.json index 009a45b214..e0f06a3581 100644 --- a/openapi/v2/mgmt/openapi.bundle.json +++ b/openapi/v2/mgmt/openapi.bundle.json @@ -38,7 +38,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/customer" + "$ref": "#/paths/~1customers~1%7Bcustomer_id%7D/get/responses/200/content/application~1json/schema" } } } @@ -100,17 +100,31 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/customer" - }, - "examples": { - "Example": { - "value": { - "application_id": "d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69", - "name": "MyCompany Inc", - "email": "contact@mycompany.com", - "customer_id": "your-customers-unique-application-id" + "type": "object", + "properties": { + "application_id": { + "type": "string", + "example": "d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69" + }, + "customer_id": { + "type": "string", + "example": "your-customers-unique-application-id" + }, + "name": { + "type": "string", + "example": "MyCompany Inc" + }, + "email": { + "type": "string", + "example": "contact@mycompany.com" } - } + }, + "required": [ + "application_id", + "name", + "email", + "customer_id" + ] } } } @@ -134,17 +148,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/customer" - }, - "examples": { - "Example": { - "value": { - "application_id": "d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69", - "name": "MyCompany Inc", - "email": "contact@mycompany.com", - "customer_id": "your-customers-unique-application-id" - } - } + "$ref": "#/paths/~1customers~1%7Bcustomer_id%7D/get/responses/200/content/application~1json/schema" } } } @@ -163,153 +167,6 @@ } ] }, - "/destinations": { - "get": { - "operationId": "getDestinations", - "tags": [ - "Destinations" - ], - "security": [ - { - "x-api-key": [] - } - ], - "summary": "List destinations", - "description": "Get a list of destinations", - "responses": { - "200": { - "description": "Destinations", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/destination" - }, - "example": [ - { - "id": "92bc3460-a301-4116-8d1f-6e5f8252c2e2", - "application_id": "9b9a31bb-9fe4-4fa5-ba84-4c035a27f258", - "name": "My Postgres Destination", - "type": "postgres", - "config": { - "host": "production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com", - "port": 5432, - "database": "my_database", - "schema": "public", - "user": "user", - "password": "password" - } - } - ] - } - } - } - } - } - }, - "post": { - "operationId": "createDestination", - "summary": "Create destination", - "tags": [ - "Destinations" - ], - "security": [ - { - "x-api-key": [] - } - ], - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/create_destination" - } - } - } - }, - "responses": { - "201": { - "description": "Destination created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/destination" - } - } - } - } - } - } - }, - "/destinations/{destination_id}": { - "get": { - "operationId": "getDestination", - "summary": "Get destination", - "tags": [ - "Destinations" - ], - "security": [ - { - "x-api-key": [] - } - ], - "responses": { - "200": { - "description": "Destination", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/destination" - } - } - } - } - } - }, - "put": { - "operationId": "updateDestination", - "summary": "Update destination", - "tags": [ - "Destinations" - ], - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/update_destination" - } - } - } - }, - "responses": { - "200": { - "description": "Destination", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/destination" - } - } - } - } - } - }, - "parameters": [ - { - "name": "destination_id", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ] - }, "/magic_links": { "get": { "operationId": "getMagicLinks", @@ -911,161 +768,6 @@ } ] }, - "/providers": { - "get": { - "operationId": "getProviders", - "tags": [ - "Providers" - ], - "security": [ - { - "x-api-key": [] - } - ], - "summary": "List providers", - "description": "Get a list of providers", - "responses": { - "200": { - "description": "Providers", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/provider" - } - } - } - } - } - } - }, - "post": { - "operationId": "createProvider", - "summary": "Create provider", - "tags": [ - "Providers" - ], - "security": [ - { - "x-api-key": [] - } - ], - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/create_provider" - } - } - } - }, - "responses": { - "201": { - "description": "Provider created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/provider" - } - } - } - } - } - } - }, - "/providers/{provider_id}": { - "get": { - "operationId": "getProvider", - "summary": "Get provider", - "tags": [ - "Providers" - ], - "security": [ - { - "x-api-key": [] - } - ], - "responses": { - "200": { - "description": "Provider", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/provider" - } - } - } - } - } - }, - "put": { - "operationId": "updateProvider", - "summary": "Update provider", - "tags": [ - "Providers" - ], - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/update_provider" - } - } - } - }, - "responses": { - "200": { - "description": "Provider", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/provider" - } - } - } - } - } - }, - "delete": { - "operationId": "deleteProvider", - "summary": "Delete provider", - "tags": [ - "Providers" - ], - "security": [ - { - "x-api-key": [] - } - ], - "responses": { - "200": { - "description": "Provider", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/provider" - } - } - } - } - } - }, - "parameters": [ - { - "name": "provider_id", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ] - }, "/sync_configs": { "get": { "operationId": "getSyncConfigs", @@ -1094,134 +796,8 @@ } } } - }, - "post": { - "operationId": "createSyncConfig", - "summary": "Create Sync Config", - "tags": [ - "SyncConfigs" - ], - "security": [ - { - "x-api-key": [] - } - ], - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/create_update_sync_config" - } - } - } - }, - "responses": { - "201": { - "description": "SyncConfig created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/sync_config" - } - } - } - } - } } }, - "/sync_configs/{sync_config_id}": { - "get": { - "operationId": "getSyncConfig", - "summary": "Get Sync Config", - "tags": [ - "SyncConfigs" - ], - "security": [ - { - "x-api-key": [] - } - ], - "responses": { - "200": { - "description": "SyncConfig", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/sync_config" - } - } - } - } - } - }, - "put": { - "operationId": "updateSyncConfig", - "summary": "Update Sync Config", - "tags": [ - "SyncConfigs" - ], - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/create_update_sync_config" - } - } - } - }, - "responses": { - "200": { - "description": "SyncConfig", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/sync_config" - } - } - } - } - } - }, - "delete": { - "operationId": "deleteSyncConfig", - "summary": "Delete Sync Config", - "tags": [ - "SyncConfigs" - ], - "security": [ - { - "x-api-key": [] - } - ], - "responses": { - "200": { - "description": "SyncConfig", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/sync_config" - } - } - } - } - } - }, - "parameters": [ - { - "name": "sync_config_id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "example": "d583ec72-55d4-4f35-9668-f6c759674cc1" - } - } - ] - }, "/connection_sync_configs": { "get": { "operationId": "getConnectionSyncConfig", @@ -1629,15 +1205,6 @@ "allOf": [ { "$ref": "#/components/schemas/connection" - }, - { - "type": "object", - "properties": { - "user_id": { - "type": "string", - "description": "The id of the user associated with this connection. This is sometimes also known as the owner." - } - } } ] } @@ -1757,6 +1324,7 @@ }, { "name": "entity_id", + "deprecated": true, "in": "query", "schema": { "type": "string", @@ -1812,19 +1380,6 @@ "application/json": { "schema": { "oneOf": [ - { - "type": "object", - "title": "Data model: Entities", - "properties": { - "entity_id": { - "type": "string", - "description": "The entity id to filter by" - } - }, - "required": [ - "entity_id" - ] - }, { "type": "object", "title": "Data model: Objects", @@ -1872,6 +1427,20 @@ "object_type", "object" ] + }, + { + "type": "object", + "title": "Data model: Entities", + "deprecated": true, + "properties": { + "entity_id": { + "type": "string", + "description": "The entity id to filter by" + } + }, + "required": [ + "entity_id" + ] } ] } @@ -1918,20 +1487,6 @@ "application/json": { "schema": { "oneOf": [ - { - "type": "object", - "title": "Data model: Entities", - "properties": { - "entity_id": { - "type": "string", - "example": "cfba6060-c43a-4a63-8a8c-501c6099f8b0", - "description": "The entity id to filter by" - } - }, - "required": [ - "entity_id" - ] - }, { "type": "object", "title": "Data model: Objects", @@ -1956,6 +1511,21 @@ "object_type", "object" ] + }, + { + "type": "object", + "title": "Data model: Entities", + "deprecated": true, + "properties": { + "entity_id": { + "type": "string", + "example": "cfba6060-c43a-4a63-8a8c-501c6099f8b0", + "description": "The entity id to filter by" + } + }, + "required": [ + "entity_id" + ] } ] } @@ -1995,38 +1565,21 @@ "/syncs/_trigger": { "post": { "operationId": "triggerSync", - "summary": "Trigger sync", - "tags": [ - "Syncs" - ], - "security": [ - { - "x-api-key": [] - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "type": "object", - "title": "Data model: Entities", - "properties": { - "entity_id": { - "type": "string", - "description": "The entity id to filter by" - }, - "perform_full_refresh": { - "type": "boolean", - "example": true - } - }, - "required": [ - "entity_id" - ] - }, + "summary": "Trigger sync", + "tags": [ + "Syncs" + ], + "security": [ + { + "x-api-key": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ { "type": "object", "title": "Data model: Objects", @@ -2081,6 +1634,24 @@ "object_type", "object" ] + }, + { + "type": "object", + "title": "Data model: Entities", + "deprecated": true, + "properties": { + "entity_id": { + "type": "string", + "description": "The entity id to filter by" + }, + "perform_full_refresh": { + "type": "boolean", + "example": true + } + }, + "required": [ + "entity_id" + ] } ] } @@ -2183,6 +1754,7 @@ }, { "name": "entity_id", + "deprecated": true, "in": "query", "schema": { "type": "string", @@ -2206,7 +1778,7 @@ "type": "string", "example": ">2021-01-06T03:24:53.434326Z" }, - "description": "The start time to filter by. Should start with one of [>, <] followed by an ISO 8601 timestamp." + "description": "The start time to filter by. Should start with one of [`>`, `<`] followed by an ISO 8601 timestamp." }, { "name": "end_timestamp", @@ -2215,7 +1787,7 @@ "type": "string", "example": ">2021-01-06T03:24:53.434326Z" }, - "description": "The end time to filter by. Should start with [>, <] followed by an ISO 8601 timestamp." + "description": "The end time to filter by. Should start with [`>`, `<`] followed by an ISO 8601 timestamp." } ], "responses": { @@ -2390,7 +1962,8 @@ "type": "string", "enum": [ "oauth2", - "api_key" + "api_key", + "access_key_secret" ], "example": "oauth2" }, @@ -2398,13 +1971,71 @@ "$ref": "#/components/schemas/provider_name" }, "config": { - "$ref": "#/components/schemas/create_provider_config" + "type": "object", + "description": "An object that stores Oauth2/API key/access key related credentials.", + "properties": { + "provider_app_id": { + "type": "string", + "example": "my_app_id" + }, + "use_managed_oauth": { + "type": "boolean", + "description": "True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.", + "example": true + }, + "oauth": { + "type": "object", + "properties": { + "oauth_scopes": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "crm.objects.contacts.read", + "crm.objects.companies.read", + "crm.objects.deals.read", + "crm.objects.owners.read", + "crm.objects.contacts.write", + "crm.objects.companies.write", + "crm.objects.deals.write" + ] + }, + "credentials": { + "type": "object", + "properties": { + "oauth_client_id": { + "type": "string", + "example": "7393b5a4-5e20-4648-87af-b7b297793fd1" + }, + "oauth_client_secret": { + "type": "string", + "example": "941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a" + } + }, + "required": [ + "oauth_client_id", + "oauth_client_secret" + ] + } + }, + "required": [ + "oauth_scopes", + "credentials" + ] + } + }, + "required": [ + "provider_app_id", + "oauth" + ] }, "objects": { "$ref": "#/components/schemas/objects" }, "entity_mappings": { "type": "array", + "deprecated": true, "description": "This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers.", "items": { "$ref": "#/components/schemas/provider_entity_mapping" @@ -2436,7 +2067,7 @@ "oneOf": [ { "type": "object", - "title": "supaglue", + "title": "postgres", "properties": { "id": { "type": "string", @@ -2446,27 +2077,39 @@ "type": "string", "example": "726fb798-d854-4c59-9a23-57e3e2f73eae" }, + "name": { + "type": "string", + "example": "My Postgres Destination" + }, "type": { "type": "string", "enum": [ - "supaglue" + "postgres" ], - "example": "supaglue" + "example": "postgres" + }, + "config": { + "$ref": "#/components/schemas/postgres_config_safe" }, "version": { - "type": "number" + "type": "number", + "example": 1, + "description": "A monotonically increasing version number of the destination configuration" } }, "required": [ "id", "application_id", + "name", "type", + "config", "version" ] }, { "type": "object", - "title": "postgres", + "title": "supaglue", + "description": "A Supaglue-hosted Postgres database destination for Listing APIs.", "properties": { "id": { "type": "string", @@ -2476,30 +2119,23 @@ "type": "string", "example": "726fb798-d854-4c59-9a23-57e3e2f73eae" }, - "name": { - "type": "string", - "example": "My Postgres Destination" - }, "type": { "type": "string", "enum": [ - "postgres" + "supaglue" ], - "example": "postgres" - }, - "config": { - "$ref": "#/components/schemas/postgres_config_safe" + "example": "supaglue" }, "version": { - "type": "number" + "type": "number", + "example": 1, + "description": "A monotonically increasing version number of the destination configuration" } }, "required": [ "id", "application_id", - "name", "type", - "config", "version" ] }, @@ -2530,7 +2166,9 @@ "$ref": "#/components/schemas/bigquery_config_safe" }, "version": { - "type": "number" + "type": "number", + "example": 1, + "description": "A monotonically increasing version number of the destination configuration" } }, "required": [ @@ -2569,7 +2207,9 @@ "$ref": "#/components/schemas/mongodb_config_safe" }, "version": { - "type": "number" + "type": "number", + "example": 1, + "description": "A monotonically increasing version number of the destination configuration" } }, "required": [ @@ -2885,6 +2525,7 @@ }, "schema": { "type": "object", + "deprecated": true, "properties": { "id": { "type": "string", @@ -2911,6 +2552,7 @@ }, "schema_config": { "type": "object", + "deprecated": true, "properties": { "fields": { "type": "array", @@ -2953,7 +2595,11 @@ }, "status": { "type": "string", - "example": "created" + "enum": [ + "new", + "consumed" + ], + "example": "new" }, "application_id": { "type": "string", @@ -2983,7 +2629,8 @@ "expires_at": { "type": "string", "format": "date-time", - "example": "2023-02-23T00:00:00Z" + "example": "2023-02-23T00:00:00Z", + "description": "Any ISO formatted date-time string indicating when the magic link expires." } }, "required": [ @@ -3027,6 +2674,7 @@ }, "entity": { "type": "object", + "deprecated": true, "properties": { "id": { "type": "string", @@ -3053,6 +2701,7 @@ }, "entity_config": { "type": "object", + "deprecated": true, "properties": { "fields": { "type": "array", @@ -3262,6 +2911,7 @@ "schema_mappings_config": { "description": "This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).", "type": "object", + "deprecated": true, "properties": { "common_objects": { "type": "array", @@ -3313,10 +2963,14 @@ "entity_mappings": { "type": "array", "description": "This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).", + "deprecated": true, "items": { "$ref": "#/components/schemas/connection_entity_mapping" }, "example": [] + }, + "connection_sync_config": { + "$ref": "#/components/schemas/connection_sync_config" } }, "required": [ @@ -3438,6 +3092,7 @@ }, "entities": { "type": "array", + "deprecated": true, "items": { "type": "object", "properties": { @@ -3456,127 +3111,6 @@ "default_config" ] }, - "create_provider_config": { - "type": "object", - "description": "An object that stores Oauth2/API key/access key related credentials.", - "properties": { - "provider_app_id": { - "type": "string", - "example": "my_app_id" - }, - "use_managed_oauth": { - "type": "boolean", - "description": "True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.", - "example": true - }, - "oauth": { - "type": "object", - "properties": { - "oauth_scopes": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "crm.objects.contacts.read", - "crm.objects.companies.read", - "crm.objects.deals.read", - "crm.objects.owners.read", - "crm.objects.contacts.write", - "crm.objects.companies.write", - "crm.objects.deals.write" - ] - }, - "credentials": { - "type": "object", - "properties": { - "oauth_client_id": { - "type": "string", - "example": "7393b5a4-5e20-4648-87af-b7b297793fd1" - }, - "oauth_client_secret": { - "type": "string", - "example": "941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a" - } - }, - "required": [ - "oauth_client_id", - "oauth_client_secret" - ] - } - }, - "required": [ - "oauth_scopes", - "credentials" - ] - } - }, - "required": [ - "provider_app_id", - "oauth" - ] - }, - "update_provider_config": { - "type": "object", - "description": "An object that stores Oauth2/API key/access key related credentials.", - "properties": { - "provider_app_id": { - "type": "string" - }, - "oauth": { - "type": "object", - "properties": { - "oauth_scopes": { - "type": "array", - "items": { - "type": "string" - } - }, - "credentials": { - "type": "object", - "properties": { - "oauth_client_id": { - "type": "string" - }, - "oauth_client_secret": { - "type": "string" - } - }, - "required": [ - "oauth_client_id", - "oauth_client_secret" - ] - } - }, - "required": [ - "oauth_scopes", - "credentials" - ] - } - }, - "required": [ - "provider_app_id", - "oauth" - ], - "example": { - "provider_app_id": "my_app_id", - "oauth": { - "oauth_scopes": [ - "crm.objects.contacts.read", - "crm.objects.companies.read", - "crm.objects.deals.read", - "crm.objects.owners.read", - "crm.objects.contacts.write", - "crm.objects.companies.write", - "crm.objects.deals.write" - ], - "credentials": { - "oauth_client_id": "7393b5a4-5e20-4648-87af-b7b297793fd1", - "oauth_client_secret": "941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a" - } - } - } - }, "provider_name": { "type": "string", "enum": [ @@ -3633,7 +3167,7 @@ "oneOf": [ { "type": "object", - "title": "Data model: Entities", + "title": "Data model: Objects", "properties": { "id": { "type": "string", @@ -3642,13 +3176,23 @@ "type": { "type": "string", "enum": [ - "entity" + "object" ], - "example": "entity" + "example": "object" }, - "entity_id": { + "object_type": { "type": "string", - "example": "94e6cb6c-0ec8-423f-8873-21054979a6b1" + "enum": [ + "common", + "standard", + "custom" + ], + "example": "standard" + }, + "object": { + "type": "string", + "example": "contact", + "description": "The Provider's object name (case sensitive)" }, "connection_id": { "type": "string", @@ -3666,7 +3210,8 @@ "required": [ "id", "type", - "entity_id", + "object_type", + "object", "connection_id", "sync_config_id", "paused" @@ -3674,7 +3219,7 @@ }, { "type": "object", - "title": "Data model: Objects", + "title": "Data model: Common Schema", "properties": { "id": { "type": "string", @@ -3690,16 +3235,14 @@ "object_type": { "type": "string", "enum": [ - "common", - "standard", - "custom" + "common" ], "example": "standard" }, "object": { "type": "string", "example": "contact", - "description": "The Provider's object name (case sensitive)" + "description": "Supaglue's object name" }, "connection_id": { "type": "string", @@ -3726,7 +3269,8 @@ }, { "type": "object", - "title": "Data model: Common Schema", + "title": "Data model: Entities", + "deprecated": true, "properties": { "id": { "type": "string", @@ -3735,21 +3279,13 @@ "type": { "type": "string", "enum": [ - "object" - ], - "example": "object" - }, - "object_type": { - "type": "string", - "enum": [ - "common" + "entity" ], - "example": "standard" + "example": "entity" }, - "object": { + "entity_id": { "type": "string", - "example": "contact", - "description": "Supaglue's object name" + "example": "94e6cb6c-0ec8-423f-8873-21054979a6b1" }, "connection_id": { "type": "string", @@ -3767,8 +3303,7 @@ "required": [ "id", "type", - "object_type", - "object", + "entity_id", "connection_id", "sync_config_id", "paused" @@ -3780,7 +3315,7 @@ "oneOf": [ { "type": "object", - "title": "Data model: Entities", + "title": "Data model: Objects", "properties": { "id": { "type": "string", @@ -3789,13 +3324,22 @@ "type": { "type": "string", "enum": [ - "entity" + "object" ], - "example": "entity" + "example": "object" }, - "entity_id": { + "object_type": { "type": "string", - "example": "70da3830-b717-49cb-91f0-22fb3f09a97a" + "enum": [ + "common", + "standard", + "custom" + ], + "example": "standard" + }, + "object": { + "type": "string", + "example": "contact" }, "connection_id": { "type": "string", @@ -3821,7 +3365,8 @@ "required": [ "id", "type", - "entity_id", + "object_type", + "object", "connection_id", "sync_config_id", "paused", @@ -3831,31 +3376,22 @@ }, { "type": "object", - "title": "Data model: Objects", + "title": "Data model: Entities", "properties": { "id": { "type": "string", "example": "971cb76d-9558-42fe-8f3b-8a531c32bd5f" }, - "type": { - "type": "string", - "enum": [ - "object" - ], - "example": "object" - }, - "object_type": { + "type": { "type": "string", "enum": [ - "common", - "standard", - "custom" + "entity" ], - "example": "standard" + "example": "entity" }, - "object": { + "entity_id": { "type": "string", - "example": "contact" + "example": "70da3830-b717-49cb-91f0-22fb3f09a97a" }, "connection_id": { "type": "string", @@ -3881,8 +3417,7 @@ "required": [ "id", "type", - "object_type", - "object", + "entity_id", "connection_id", "sync_config_id", "paused", @@ -3898,6 +3433,14 @@ "type": "object", "title": "Data model: Objects", "properties": { + "id": { + "type": "string", + "example": "20eb4da3-6b38-4ec6-a82d-ecee59a9d6d9" + }, + "sync_id": { + "type": "string", + "example": "629525f8-f6f7-436c-80fa-1cb23acc5bf8" + }, "object_type": { "type": "string", "enum": [ @@ -3955,6 +3498,8 @@ } }, "required": [ + "id", + "sync_id", "object_type", "object", "start_timestamp", @@ -3972,9 +3517,19 @@ { "type": "object", "title": "Data model: Entities", + "deprecated": true, "properties": { + "id": { + "type": "string", + "example": "20eb4da3-6b38-4ec6-a82d-ecee59a9d6d9" + }, + "sync_id": { + "type": "string", + "example": "629525f8-f6f7-436c-80fa-1cb23acc5bf8" + }, "entity_id": { - "type": "string" + "type": "string", + "deprecated": true }, "error_message": { "type": "string", @@ -4022,6 +3577,8 @@ } }, "required": [ + "id", + "sync_id", "entity_id", "start_timestamp", "end_timestamp", @@ -4072,7 +3629,7 @@ ] }, "config": { - "$ref": "#/components/schemas/create_provider_config" + "$ref": "#/components/schemas/provider/properties/config" }, "objects": { "$ref": "#/components/schemas/objects" @@ -4105,7 +3662,7 @@ ] }, "config": { - "$ref": "#/components/schemas/create_provider_config" + "$ref": "#/components/schemas/provider/properties/config" }, "objects": { "$ref": "#/components/schemas/objects" @@ -4166,7 +3723,65 @@ ] }, "config": { - "$ref": "#/components/schemas/update_provider_config" + "type": "object", + "description": "An object that stores Oauth2/API key/access key related credentials.", + "properties": { + "provider_app_id": { + "type": "string" + }, + "oauth": { + "type": "object", + "properties": { + "oauth_scopes": { + "type": "array", + "items": { + "type": "string" + } + }, + "credentials": { + "type": "object", + "properties": { + "oauth_client_id": { + "type": "string" + }, + "oauth_client_secret": { + "type": "string" + } + }, + "required": [ + "oauth_client_id", + "oauth_client_secret" + ] + } + }, + "required": [ + "oauth_scopes", + "credentials" + ] + } + }, + "required": [ + "provider_app_id", + "oauth" + ], + "example": { + "provider_app_id": "my_app_id", + "oauth": { + "oauth_scopes": [ + "crm.objects.contacts.read", + "crm.objects.companies.read", + "crm.objects.deals.read", + "crm.objects.owners.read", + "crm.objects.contacts.write", + "crm.objects.companies.write", + "crm.objects.deals.write" + ], + "credentials": { + "oauth_client_id": "7393b5a4-5e20-4648-87af-b7b297793fd1", + "oauth_client_secret": "941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a" + } + } + } }, "objects": { "$ref": "#/components/schemas/objects" @@ -4205,7 +3820,7 @@ ] }, "config": { - "$ref": "#/components/schemas/update_provider_config" + "$ref": "#/components/schemas/update_provider/oneOf/0/properties/config" }, "objects": { "$ref": "#/components/schemas/objects" @@ -4244,7 +3859,7 @@ ] }, "config": { - "$ref": "#/components/schemas/update_provider_config" + "$ref": "#/components/schemas/update_provider/oneOf/0/properties/config" }, "objects": { "$ref": "#/components/schemas/objects" @@ -4306,228 +3921,6 @@ "config" ] }, - "create_destination": { - "oneOf": [ - { - "type": "object", - "title": "postgres", - "properties": { - "type": { - "type": "string", - "enum": [ - "supaglue" - ], - "example": "supaglue" - } - }, - "required": [ - "type" - ] - }, - { - "type": "object", - "title": "postgres", - "properties": { - "name": { - "type": "string", - "example": "My Postgres Destination" - }, - "type": { - "type": "string", - "enum": [ - "postgres" - ], - "example": "postgres" - }, - "config": { - "$ref": "#/components/schemas/postgres_config_unsafe" - } - }, - "required": [ - "name", - "type", - "config" - ] - }, - { - "type": "object", - "title": "bigquery", - "properties": { - "name": { - "type": "string", - "example": "My BigQuery Destination" - }, - "type": { - "type": "string", - "enum": [ - "bigquery" - ], - "example": "bigquery" - }, - "config": { - "$ref": "#/components/schemas/bigquery_config_unsafe" - } - }, - "required": [ - "name", - "type", - "config" - ] - }, - { - "type": "object", - "title": "mongodb", - "properties": { - "name": { - "type": "string", - "example": "My MongoDB Destination" - }, - "type": { - "type": "string", - "enum": [ - "mongodb" - ], - "example": "mongodb" - }, - "config": { - "$ref": "#/components/schemas/mongodb_config_unsafe" - } - }, - "required": [ - "name", - "type", - "config" - ] - } - ] - }, - "update_destination": { - "example": { - "name": "My Postgres Destination", - "type": "postgres", - "config": { - "host": "production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com", - "port": 5432, - "database": "postgres_prod_db", - "schema": "public", - "user": "myuser", - "password": "mysensitivepassword" - } - }, - "oneOf": [ - { - "type": "object", - "title": "postgres", - "properties": { - "name": { - "type": "string", - "example": "My Postgres Destination" - }, - "type": { - "type": "string", - "enum": [ - "postgres" - ], - "example": "postgres" - }, - "config": { - "$ref": "#/components/schemas/postgres_config_at_least_safe" - }, - "version": { - "type": "number", - "example": "number" - } - }, - "required": [ - "name", - "type", - "config", - "version" - ] - }, - { - "type": "object", - "title": "bigquery", - "properties": { - "name": { - "type": "string", - "example": "My BigQuery Destination" - }, - "type": { - "type": "string", - "enum": [ - "bigquery" - ], - "example": "bigquery" - }, - "config": { - "$ref": "#/components/schemas/bigquery_config_at_least_safe" - }, - "version": { - "type": "number", - "example": "number" - } - }, - "required": [ - "name", - "type", - "config", - "version" - ] - }, - { - "type": "object", - "title": "mongodb", - "properties": { - "name": { - "type": "string", - "example": "My MongoDB Destination" - }, - "type": { - "type": "string", - "enum": [ - "mongodb" - ], - "example": "mongodb" - }, - "config": { - "$ref": "#/components/schemas/mongodb_config_at_least_safe" - }, - "version": { - "type": "number", - "example": "number" - } - }, - "required": [ - "name", - "type", - "config", - "version" - ] - } - ] - }, - "create_update_sync_config": { - "type": "object", - "properties": { - "destination_id": { - "type": "string", - "example": "6e7baa88-84dd-4dbc-902a-14522c2984eb" - }, - "provider_id": { - "type": "string", - "example": "7f72ec07-e5c1-47fd-8cf5-e71dd13873af" - }, - "config": { - "$ref": "#/components/schemas/sync_config_data" - } - }, - "required": [ - "destination_id", - "provider_id", - "config" - ] - }, "webhook-payload": { "oneOf": [ { @@ -4881,6 +4274,7 @@ }, "provider_entity_mapping": { "type": "object", + "deprecated": true, "properties": { "entity_id": { "type": "string", @@ -4902,6 +4296,7 @@ }, "connection_entity_mapping": { "type": "object", + "deprecated": true, "properties": { "entity_id": { "type": "string" @@ -4992,6 +4387,7 @@ }, "entity_field_mapping": { "type": "object", + "deprecated": true, "properties": { "entity_field": { "type": "string", diff --git a/openapi/v2/mgmt/openapi.yaml b/openapi/v2/mgmt/openapi.yaml index d7c5a99553..dcdc00afb5 100644 --- a/openapi/v2/mgmt/openapi.yaml +++ b/openapi/v2/mgmt/openapi.yaml @@ -31,10 +31,6 @@ paths: $ref: paths/customers.yaml '/customers/{customer_id}': $ref: paths/customers@{customer_id}.yaml - '/destinations': - $ref: paths/destinations.yaml - '/destinations/{destination_id}': - $ref: paths/destinations@{destination_id}.yaml '/magic_links': $ref: paths/magic_links.yaml '/magic_links/{magic_link_id}': @@ -55,14 +51,8 @@ paths: $ref: paths/entities.yaml '/entities/{entity_id}': $ref: paths/entities@{entity_id}.yaml - '/providers': - $ref: paths/providers.yaml - '/providers/{provider_id}': - $ref: paths/providers@{provider_id}.yaml '/sync_configs': $ref: paths/sync_configs.yaml - '/sync_configs/{sync_config_id}': - $ref: paths/sync_configs@{sync_config_id}.yaml '/connection_sync_configs': $ref: paths/connection_sync_configs.yaml '/customers/{customer_id}/connections': @@ -171,10 +161,6 @@ components: $ref: ./components/schemas/objects/sync_config.yaml sync_config_data: $ref: ./components/schemas/objects/sync_config_data.yaml - create_provider_config: - $ref: ./components/schemas/objects/create_provider_config.yaml - update_provider_config: - $ref: ./components/schemas/objects/update_provider_config.yaml provider_name: $ref: ./components/schemas/objects/provider_name.yaml provider_name_crm: @@ -199,12 +185,6 @@ components: $ref: ./components/schemas/create_update_schema.yaml create_update_entity: $ref: ./components/schemas/create_update_entity.yaml - create_destination: - $ref: ./components/schemas/create_destination.yaml - update_destination: - $ref: ./components/schemas/update_destination.yaml - create_update_sync_config: - $ref: ./components/schemas/create_update_sync_config.yaml webhook-payload: $ref: './components/schemas/webhook-payload.yaml' upsert_connection_sync_config: diff --git a/openapi/v2/mgmt/paths/connections@{connection_id}.yaml b/openapi/v2/mgmt/paths/connections@{connection_id}.yaml index f1a2998517..53ac00ffdb 100644 --- a/openapi/v2/mgmt/paths/connections@{connection_id}.yaml +++ b/openapi/v2/mgmt/paths/connections@{connection_id}.yaml @@ -13,11 +13,6 @@ get: schema: allOf: - $ref: ../components/schemas/objects/connection.yaml - - type: object - properties: - user_id: - type: string - description: The id of the user associated with this connection. This is sometimes also known as the owner. delete: operationId: deleteConnection summary: Delete connection diff --git a/openapi/v2/mgmt/paths/customers.yaml b/openapi/v2/mgmt/paths/customers.yaml index 350cec9bef..6394948820 100644 --- a/openapi/v2/mgmt/paths/customers.yaml +++ b/openapi/v2/mgmt/paths/customers.yaml @@ -15,7 +15,7 @@ get: schema: type: array items: - $ref: ../components/schemas/objects/customer.yaml + $ref: ../components/schemas/objects/simple_customer.yaml put: operationId: upsertCustomer summary: Upsert customer diff --git a/openapi/v2/mgmt/paths/customers@{customer_id}.yaml b/openapi/v2/mgmt/paths/customers@{customer_id}.yaml index fc72ac3cf0..a099c9a9fd 100644 --- a/openapi/v2/mgmt/paths/customers@{customer_id}.yaml +++ b/openapi/v2/mgmt/paths/customers@{customer_id}.yaml @@ -11,14 +11,7 @@ get: content: application/json: schema: - $ref: ../components/schemas/objects/customer.yaml - examples: - Example: - value: - application_id: d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69 - name: MyCompany Inc - email: contact@mycompany.com - customer_id: your-customers-unique-application-id + $ref: ../components/schemas/objects/simple_customer.yaml delete: operationId: deleteCustomer summary: Delete customer @@ -32,14 +25,7 @@ delete: content: application/json: schema: - $ref: ../components/schemas/objects/customer.yaml - examples: - Example: - value: - application_id: d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69 - name: MyCompany Inc - email: contact@mycompany.com - customer_id: your-customers-unique-application-id + $ref: ../components/schemas/objects/simple_customer.yaml parameters: - name: customer_id in: path diff --git a/openapi/v2/mgmt/paths/destinations.yaml b/openapi/v2/mgmt/paths/destinations.yaml deleted file mode 100644 index e2fbaaa11a..0000000000 --- a/openapi/v2/mgmt/paths/destinations.yaml +++ /dev/null @@ -1,52 +0,0 @@ -get: - operationId: getDestinations - tags: - - Destinations - security: - - x-api-key: [] - summary: List destinations - description: >- - Get a list of destinations - responses: - '200': - description: Destinations - content: - application/json: - schema: - type: array - items: - $ref: ../components/schemas/objects/destination.yaml - # example here since destination.yaml uses oneOf - example: - - id: 92bc3460-a301-4116-8d1f-6e5f8252c2e2 - application_id: 9b9a31bb-9fe4-4fa5-ba84-4c035a27f258 - name: My Postgres Destination - type: postgres - config: - host: production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com - port: 5432 - database: my_database - schema: public - user: user - password: password -post: - operationId: createDestination - summary: Create destination - tags: - - Destinations - security: - - x-api-key: [] - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - $ref: ../components/schemas/create_destination.yaml - responses: - '201': - description: Destination created - content: - application/json: - schema: - $ref: ../components/schemas/objects/destination.yaml diff --git a/openapi/v2/mgmt/paths/destinations@{destination_id}.yaml b/openapi/v2/mgmt/paths/destinations@{destination_id}.yaml deleted file mode 100644 index 0ed8ba36ce..0000000000 --- a/openapi/v2/mgmt/paths/destinations@{destination_id}.yaml +++ /dev/null @@ -1,39 +0,0 @@ -get: - operationId: getDestination - summary: Get destination - tags: - - Destinations - security: - - x-api-key: [] - responses: - 200: - description: Destination - content: - application/json: - schema: - $ref: ../components/schemas/objects/destination.yaml -put: - operationId: updateDestination - summary: Update destination - tags: - - Destinations - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - $ref: ../components/schemas/update_destination.yaml - responses: - 200: - description: Destination - content: - application/json: - schema: - $ref: ../components/schemas/objects/destination.yaml -parameters: - - name: destination_id - in: path - required: true - schema: - type: string diff --git a/openapi/v2/mgmt/paths/providers.yaml b/openapi/v2/mgmt/paths/providers.yaml deleted file mode 100644 index be8c31e0bd..0000000000 --- a/openapi/v2/mgmt/paths/providers.yaml +++ /dev/null @@ -1,39 +0,0 @@ -get: - operationId: getProviders - tags: - - Providers - security: - - x-api-key: [] - summary: List providers - description: >- - Get a list of providers - responses: - '200': - description: Providers - content: - application/json: - schema: - type: array - items: - $ref: ../components/schemas/objects/provider.yaml -post: - operationId: createProvider - summary: Create provider - tags: - - Providers - security: - - x-api-key: [] - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - $ref: ../components/schemas/create_provider.yaml - responses: - '201': - description: Provider created - content: - application/json: - schema: - $ref: ../components/schemas/objects/provider.yaml diff --git a/openapi/v2/mgmt/paths/providers@{provider_id}.yaml b/openapi/v2/mgmt/paths/providers@{provider_id}.yaml deleted file mode 100644 index 68d6a99d91..0000000000 --- a/openapi/v2/mgmt/paths/providers@{provider_id}.yaml +++ /dev/null @@ -1,53 +0,0 @@ -get: - operationId: getProvider - summary: Get provider - tags: - - Providers - security: - - x-api-key: [] - responses: - 200: - description: Provider - content: - application/json: - schema: - $ref: ../components/schemas/objects/provider.yaml -put: - operationId: updateProvider - summary: Update provider - tags: - - Providers - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - $ref: ../components/schemas/update_provider.yaml - responses: - 200: - description: Provider - content: - application/json: - schema: - $ref: ../components/schemas/objects/provider.yaml -delete: - operationId: deleteProvider - summary: Delete provider - tags: - - Providers - security: - - x-api-key: [] - responses: - 200: - description: Provider - content: - application/json: - schema: - $ref: ../components/schemas/objects/provider.yaml -parameters: - - name: provider_id - in: path - required: true - schema: - type: string diff --git a/openapi/v2/mgmt/paths/sync_configs.yaml b/openapi/v2/mgmt/paths/sync_configs.yaml index e0c5de903a..f601c06604 100644 --- a/openapi/v2/mgmt/paths/sync_configs.yaml +++ b/openapi/v2/mgmt/paths/sync_configs.yaml @@ -16,24 +16,3 @@ get: type: array items: $ref: ../components/schemas/objects/sync_config.yaml -post: - operationId: createSyncConfig - summary: Create Sync Config - tags: - - SyncConfigs - security: - - x-api-key: [] - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - $ref: ../components/schemas/create_update_sync_config.yaml - responses: - '201': - description: SyncConfig created - content: - application/json: - schema: - $ref: ../components/schemas/objects/sync_config.yaml diff --git a/openapi/v2/mgmt/paths/sync_runs.yaml b/openapi/v2/mgmt/paths/sync_runs.yaml index 09007f670e..8558a91ca2 100644 --- a/openapi/v2/mgmt/paths/sync_runs.yaml +++ b/openapi/v2/mgmt/paths/sync_runs.yaml @@ -48,6 +48,7 @@ get: example: account description: The object to filter by - name: entity_id + deprecated: true in: query schema: type: string @@ -64,13 +65,13 @@ get: schema: type: string example: '>2021-01-06T03:24:53.434326Z' - description: The start time to filter by. Should start with one of [>, <] followed by an ISO 8601 timestamp. + description: The start time to filter by. Should start with one of [`>`, `<`] followed by an ISO 8601 timestamp. - name: end_timestamp in: query schema: type: string example: '>2021-01-06T03:24:53.434326Z' - description: The end time to filter by. Should start with [>, <] followed by an ISO 8601 timestamp. + description: The end time to filter by. Should start with [`>`, `<`] followed by an ISO 8601 timestamp. responses: '200': description: SyncRun diff --git a/openapi/v2/mgmt/paths/syncs.yaml b/openapi/v2/mgmt/paths/syncs.yaml index c38821e3bb..7d6c295d44 100644 --- a/openapi/v2/mgmt/paths/syncs.yaml +++ b/openapi/v2/mgmt/paths/syncs.yaml @@ -49,6 +49,7 @@ get: example: contact description: The object to filter by - name: entity_id + deprecated: true in: query schema: type: string diff --git a/openapi/v2/mgmt/paths/syncs@_pause.yaml b/openapi/v2/mgmt/paths/syncs@_pause.yaml index cef2836916..1ebe5df622 100644 --- a/openapi/v2/mgmt/paths/syncs@_pause.yaml +++ b/openapi/v2/mgmt/paths/syncs@_pause.yaml @@ -11,14 +11,6 @@ post: application/json: schema: oneOf: - - type: object - title: 'Data model: Entities' - properties: - entity_id: - type: string - description: The entity id to filter by - required: - - entity_id - type: object title: 'Data model: Objects' properties: @@ -53,6 +45,15 @@ post: required: - object_type - object + - type: object + title: 'Data model: Entities' + deprecated: true + properties: + entity_id: + type: string + description: The entity id to filter by + required: + - entity_id responses: '200': diff --git a/openapi/v2/mgmt/paths/syncs@_resume.yaml b/openapi/v2/mgmt/paths/syncs@_resume.yaml index a8b79124ca..5066fe139c 100644 --- a/openapi/v2/mgmt/paths/syncs@_resume.yaml +++ b/openapi/v2/mgmt/paths/syncs@_resume.yaml @@ -11,15 +11,6 @@ post: application/json: schema: oneOf: - - type: object - title: 'Data model: Entities' - properties: - entity_id: - type: string - example: cfba6060-c43a-4a63-8a8c-501c6099f8b0 - description: The entity id to filter by - required: - - entity_id - type: object title: 'Data model: Objects' properties: @@ -38,6 +29,16 @@ post: required: - object_type - object + - type: object + title: 'Data model: Entities' + deprecated: true + properties: + entity_id: + type: string + example: cfba6060-c43a-4a63-8a8c-501c6099f8b0 + description: The entity id to filter by + required: + - entity_id responses: '200': description: Sync resumed diff --git a/openapi/v2/mgmt/paths/syncs@_trigger.yaml b/openapi/v2/mgmt/paths/syncs@_trigger.yaml index 927f3fa8a1..ace03a81d9 100644 --- a/openapi/v2/mgmt/paths/syncs@_trigger.yaml +++ b/openapi/v2/mgmt/paths/syncs@_trigger.yaml @@ -11,17 +11,6 @@ post: application/json: schema: oneOf: - - type: object - title: 'Data model: Entities' - properties: - entity_id: - type: string - description: The entity id to filter by - perform_full_refresh: - type: boolean - example: true - required: - - entity_id - type: object title: 'Data model: Objects' properties: @@ -61,6 +50,18 @@ post: required: - object_type - object + - type: object + title: 'Data model: Entities' + deprecated: true + properties: + entity_id: + type: string + description: The entity id to filter by + perform_full_refresh: + type: boolean + example: true + required: + - entity_id responses: '200': diff --git a/packages/schemas/gen/v2/mgmt.ts b/packages/schemas/gen/v2/mgmt.ts index 73650d36ef..a1600fb2a0 100644 --- a/packages/schemas/gen/v2/mgmt.ts +++ b/packages/schemas/gen/v2/mgmt.ts @@ -30,26 +30,6 @@ export interface paths { }; }; }; - "/destinations": { - /** - * List destinations - * @description Get a list of destinations - */ - get: operations["getDestinations"]; - /** Create destination */ - post: operations["createDestination"]; - }; - "/destinations/{destination_id}": { - /** Get destination */ - get: operations["getDestination"]; - /** Update destination */ - put: operations["updateDestination"]; - parameters: { - path: { - destination_id: string; - }; - }; - }; "/magic_links": { /** * List magic links @@ -198,49 +178,12 @@ export interface paths { }; }; }; - "/providers": { - /** - * List providers - * @description Get a list of providers - */ - get: operations["getProviders"]; - /** Create provider */ - post: operations["createProvider"]; - }; - "/providers/{provider_id}": { - /** Get provider */ - get: operations["getProvider"]; - /** Update provider */ - put: operations["updateProvider"]; - /** Delete provider */ - delete: operations["deleteProvider"]; - parameters: { - path: { - provider_id: string; - }; - }; - }; "/sync_configs": { /** * List Sync Configs * @description Get a list of Sync Configs */ get: operations["getSyncConfigs"]; - /** Create Sync Config */ - post: operations["createSyncConfig"]; - }; - "/sync_configs/{sync_config_id}": { - /** Get Sync Config */ - get: operations["getSyncConfig"]; - /** Update Sync Config */ - put: operations["updateSyncConfig"]; - /** Delete Sync Config */ - delete: operations["deleteSyncConfig"]; - parameters: { - path: { - sync_config_id: string; - }; - }; }; "/connection_sync_configs": { /** Get connection sync config */ @@ -485,11 +428,43 @@ export interface components { * @example oauth2 * @enum {string} */ - auth_type: "oauth2" | "api_key"; + auth_type: "oauth2" | "api_key" | "access_key_secret"; name: components["schemas"]["provider_name"]; - config?: components["schemas"]["create_provider_config"]; + /** @description An object that stores Oauth2/API key/access key related credentials. */ + config?: { + /** @example my_app_id */ + provider_app_id: string; + /** + * @description True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials. + * @example true + */ + use_managed_oauth?: boolean; + oauth: { + /** + * @example [ + * "crm.objects.contacts.read", + * "crm.objects.companies.read", + * "crm.objects.deals.read", + * "crm.objects.owners.read", + * "crm.objects.contacts.write", + * "crm.objects.companies.write", + * "crm.objects.deals.write" + * ] + */ + oauth_scopes: (string)[]; + credentials: { + /** @example 7393b5a4-5e20-4648-87af-b7b297793fd1 */ + oauth_client_id: string; + /** @example 941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a */ + oauth_client_secret: string; + }; + }; + }; objects?: components["schemas"]["objects"]; - /** @description This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers. */ + /** + * @deprecated + * @description This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers. + */ entity_mappings?: (components["schemas"]["provider_entity_mapping"])[]; }; /** @@ -512,25 +487,33 @@ export interface components { id: string; /** @example 726fb798-d854-4c59-9a23-57e3e2f73eae */ application_id: string; + /** @example My Postgres Destination */ + name: string; /** - * @example supaglue + * @example postgres * @enum {string} */ - type: "supaglue"; + type: "postgres"; + config: components["schemas"]["postgres_config_safe"]; + /** + * @description A monotonically increasing version number of the destination configuration + * @example 1 + */ version: number; }, { /** @example d455d20b-f6dc-4bc3-ab14-b4f21c4b4835 */ id: string; /** @example 726fb798-d854-4c59-9a23-57e3e2f73eae */ application_id: string; - /** @example My Postgres Destination */ - name: string; /** - * @example postgres + * @example supaglue * @enum {string} */ - type: "postgres"; - config: components["schemas"]["postgres_config_safe"]; + type: "supaglue"; + /** + * @description A monotonically increasing version number of the destination configuration + * @example 1 + */ version: number; }, { /** @example e888cedf-e9d0-42c5-9485-2d72984faef2 */ @@ -545,6 +528,10 @@ export interface components { */ type: "bigquery"; config: components["schemas"]["bigquery_config_safe"]; + /** + * @description A monotonically increasing version number of the destination configuration + * @example 1 + */ version: number; }, { /** @example e888cedf-e9d0-42c5-9485-2d72984faef2 */ @@ -559,6 +546,10 @@ export interface components { */ type: "mongodb"; config: components["schemas"]["mongodb_config_safe"]; + /** + * @description A monotonically increasing version number of the destination configuration + * @example 1 + */ version: number; }]>; postgres_config_safe: { @@ -673,6 +664,7 @@ export interface components { /** @example mysensitivepassword */ password: string; }; + /** @deprecated */ schema: { /** @example 649b1e49-2722-46a3-a7e7-10caae78a43f */ id: string; @@ -682,6 +674,7 @@ export interface components { name: string; config: components["schemas"]["schema_config"]; }; + /** @deprecated */ schema_config: { fields: ({ /** @@ -704,8 +697,11 @@ export interface components { magic_link: { /** @example ec208408-db29-4705-b39e-4d33070b4ef6 */ id: string; - /** @example created */ - status: string; + /** + * @example new + * @enum {string} + */ + status: "new" | "consumed"; /** @example d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69 */ application_id: string; /** @example my-customer-1 */ @@ -725,6 +721,7 @@ export interface components { return_url: string; /** * Format: date-time + * @description Any ISO formatted date-time string indicating when the magic link expires. * @example 2023-02-23T00:00:00Z */ expires_at: Date; @@ -741,6 +738,7 @@ export interface components { /** @example 18000 */ expiration_secs: number; }; + /** @deprecated */ entity: { /** @example 649b1e49-2722-46a3-a7e7-10caae78a43f */ id: string; @@ -750,6 +748,7 @@ export interface components { name: string; config: components["schemas"]["entity_config"]; }; + /** @deprecated */ entity_config: { fields: ({ /** @example apolla_first_name */ @@ -828,7 +827,10 @@ export interface components { * @example https://app.hubspot.com/contacts/123456 */ instance_url: string; - /** @description This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings). */ + /** + * @deprecated + * @description This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings). + */ schema_mappings_config?: { common_objects?: ({ /** @example Contact__c */ @@ -842,10 +844,12 @@ export interface components { })[]; }; /** + * @deprecated * @description This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping). * @example [] */ entity_mappings?: (components["schemas"]["connection_entity_mapping"])[]; + connection_sync_config?: components["schemas"]["connection_sync_config"]; }; /** * @example crm @@ -898,72 +902,12 @@ export interface components { */ object: string; })[]; + /** @deprecated */ entities?: ({ /** @example 3a82409f-c98f-4d25-bbd8-3335de3f12cc */ entity_id: string; })[]; }; - /** @description An object that stores Oauth2/API key/access key related credentials. */ - create_provider_config: { - /** @example my_app_id */ - provider_app_id: string; - /** - * @description True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials. - * @example true - */ - use_managed_oauth?: boolean; - oauth: { - /** - * @example [ - * "crm.objects.contacts.read", - * "crm.objects.companies.read", - * "crm.objects.deals.read", - * "crm.objects.owners.read", - * "crm.objects.contacts.write", - * "crm.objects.companies.write", - * "crm.objects.deals.write" - * ] - */ - oauth_scopes: (string)[]; - credentials: { - /** @example 7393b5a4-5e20-4648-87af-b7b297793fd1 */ - oauth_client_id: string; - /** @example 941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a */ - oauth_client_secret: string; - }; - }; - }; - /** - * @description An object that stores Oauth2/API key/access key related credentials. - * @example { - * "provider_app_id": "my_app_id", - * "oauth": { - * "oauth_scopes": [ - * "crm.objects.contacts.read", - * "crm.objects.companies.read", - * "crm.objects.deals.read", - * "crm.objects.owners.read", - * "crm.objects.contacts.write", - * "crm.objects.companies.write", - * "crm.objects.deals.write" - * ], - * "credentials": { - * "oauth_client_id": "7393b5a4-5e20-4648-87af-b7b297793fd1", - * "oauth_client_secret": "941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a" - * } - * } - * } - */ - update_provider_config: { - provider_app_id: string; - oauth: { - oauth_scopes: (string)[]; - credentials: { - oauth_client_id: string; - oauth_client_secret: string; - }; - }; - }; /** * @example hubspot * @enum {string} @@ -976,22 +920,6 @@ export interface components { /** @enum {string} */ provider_name_no_category: "intercom" | "gong" | "linear"; sync: OneOf<[{ - /** @example 7026e4e8-15d7-48d8-b997-f2592b654619 */ - id: string; - /** - * @example entity - * @enum {string} - */ - type: "entity"; - /** @example 94e6cb6c-0ec8-423f-8873-21054979a6b1 */ - entity_id: string; - /** @example 3217ea51-11c8-43c9-9547-6f197e02e5e4 */ - connection_id: string; - /** @example 3217ea51-11c8-43c9-9547-6f197e02e5e5 */ - sync_config_id: string; - /** @example false */ - paused: boolean; - }, { /** @example 7026e4e8-15d7-48d8-b997-f2592b654619 */ id: string; /** @@ -1039,16 +967,15 @@ export interface components { sync_config_id: string; /** @example false */ paused: boolean; - }]>; - sync_with_provider_and_customer: OneOf<[{ - /** @example 971cb76d-9558-42fe-8f3b-8a531c32bd5f */ + }, { + /** @example 7026e4e8-15d7-48d8-b997-f2592b654619 */ id: string; /** * @example entity * @enum {string} */ type: "entity"; - /** @example 70da3830-b717-49cb-91f0-22fb3f09a97a */ + /** @example 94e6cb6c-0ec8-423f-8873-21054979a6b1 */ entity_id: string; /** @example 3217ea51-11c8-43c9-9547-6f197e02e5e4 */ connection_id: string; @@ -1056,11 +983,8 @@ export interface components { sync_config_id: string; /** @example false */ paused: boolean; - /** @example hubspot */ - provider_name: string; - /** @example my-customer-1 */ - customer_id: string; - }, { + }]>; + sync_with_provider_and_customer: OneOf<[{ /** @example 971cb76d-9558-42fe-8f3b-8a531c32bd5f */ id: string; /** @@ -1085,8 +1009,32 @@ export interface components { provider_name: string; /** @example my-customer-1 */ customer_id: string; + }, { + /** @example 971cb76d-9558-42fe-8f3b-8a531c32bd5f */ + id: string; + /** + * @example entity + * @enum {string} + */ + type: "entity"; + /** @example 70da3830-b717-49cb-91f0-22fb3f09a97a */ + entity_id: string; + /** @example 3217ea51-11c8-43c9-9547-6f197e02e5e4 */ + connection_id: string; + /** @example 3217ea51-11c8-43c9-9547-6f197e02e5e5 */ + sync_config_id: string; + /** @example false */ + paused: boolean; + /** @example hubspot */ + provider_name: string; + /** @example my-customer-1 */ + customer_id: string; }]>; sync_run: OneOf<[{ + /** @example 20eb4da3-6b38-4ec6-a82d-ecee59a9d6d9 */ + id: string; + /** @example 629525f8-f6f7-436c-80fa-1cb23acc5bf8 */ + sync_id: string; /** @enum {string} */ object_type: "common" | "standard" | "custom"; object: string; @@ -1108,6 +1056,11 @@ export interface components { /** @example 100 */ num_records_synced: number | null; }, { + /** @example 20eb4da3-6b38-4ec6-a82d-ecee59a9d6d9 */ + id: string; + /** @example 629525f8-f6f7-436c-80fa-1cb23acc5bf8 */ + sync_id: string; + /** @deprecated */ entity_id: string; error_message: string | null; /** @example 2023-02-22T19:55:17.559Z */ @@ -1138,7 +1091,7 @@ export interface components { create_provider: OneOf<[{ /** @enum {string} */ auth_type: "oauth2"; - config: components["schemas"]["create_provider_config"]; + config: components["schemas"]["provider"]["config"]; objects?: components["schemas"]["objects"]; /** @enum {string} */ category: "crm"; @@ -1146,7 +1099,7 @@ export interface components { }, { /** @enum {string} */ auth_type: "oauth2"; - config: components["schemas"]["create_provider_config"]; + config: components["schemas"]["provider"]["config"]; objects?: components["schemas"]["objects"]; /** @enum {string} */ category: "engagement"; @@ -1161,7 +1114,37 @@ export interface components { update_provider: OneOf<[{ /** @enum {string} */ auth_type: "oauth2"; - config: components["schemas"]["update_provider_config"]; + /** + * @description An object that stores Oauth2/API key/access key related credentials. + * @example { + * "provider_app_id": "my_app_id", + * "oauth": { + * "oauth_scopes": [ + * "crm.objects.contacts.read", + * "crm.objects.companies.read", + * "crm.objects.deals.read", + * "crm.objects.owners.read", + * "crm.objects.contacts.write", + * "crm.objects.companies.write", + * "crm.objects.deals.write" + * ], + * "credentials": { + * "oauth_client_id": "7393b5a4-5e20-4648-87af-b7b297793fd1", + * "oauth_client_secret": "941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a" + * } + * } + * } + */ + config: { + provider_app_id: string; + oauth: { + oauth_scopes: (string)[]; + credentials: { + oauth_client_id: string; + oauth_client_secret: string; + }; + }; + }; objects?: components["schemas"]["objects"]; entity_mappings?: (components["schemas"]["provider_entity_mapping"])[]; /** @enum {string} */ @@ -1170,7 +1153,7 @@ export interface components { }, { /** @enum {string} */ auth_type: "oauth2"; - config: components["schemas"]["update_provider_config"]; + config: components["schemas"]["update_provider"]["oneOf"]["0"]["config"]; objects?: components["schemas"]["objects"]; entity_mappings?: (components["schemas"]["provider_entity_mapping"])[]; /** @enum {string} */ @@ -1179,7 +1162,7 @@ export interface components { }, { /** @enum {string} */ auth_type: "oauth2"; - config: components["schemas"]["update_provider_config"]; + config: components["schemas"]["update_provider"]["oneOf"]["0"]["config"]; objects?: components["schemas"]["objects"]; entity_mappings?: (components["schemas"]["provider_entity_mapping"])[]; /** @enum {string} */ @@ -1196,95 +1179,6 @@ export interface components { name: string; config: components["schemas"]["entity_config"]; }; - create_destination: OneOf<[{ - /** - * @example supaglue - * @enum {string} - */ - type: "supaglue"; - }, { - /** @example My Postgres Destination */ - name: string; - /** - * @example postgres - * @enum {string} - */ - type: "postgres"; - config: components["schemas"]["postgres_config_unsafe"]; - }, { - /** @example My BigQuery Destination */ - name: string; - /** - * @example bigquery - * @enum {string} - */ - type: "bigquery"; - config: components["schemas"]["bigquery_config_unsafe"]; - }, { - /** @example My MongoDB Destination */ - name: string; - /** - * @example mongodb - * @enum {string} - */ - type: "mongodb"; - config: components["schemas"]["mongodb_config_unsafe"]; - }]>; - /** - * @example { - * "name": "My Postgres Destination", - * "type": "postgres", - * "config": { - * "host": "production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com", - * "port": 5432, - * "database": "postgres_prod_db", - * "schema": "public", - * "user": "myuser", - * "password": "mysensitivepassword" - * } - * } - */ - update_destination: OneOf<[{ - /** @example My Postgres Destination */ - name: string; - /** - * @example postgres - * @enum {string} - */ - type: "postgres"; - config: components["schemas"]["postgres_config_at_least_safe"]; - /** @example number */ - version: number; - }, { - /** @example My BigQuery Destination */ - name: string; - /** - * @example bigquery - * @enum {string} - */ - type: "bigquery"; - config: components["schemas"]["bigquery_config_at_least_safe"]; - /** @example number */ - version: number; - }, { - /** @example My MongoDB Destination */ - name: string; - /** - * @example mongodb - * @enum {string} - */ - type: "mongodb"; - config: components["schemas"]["mongodb_config_at_least_safe"]; - /** @example number */ - version: number; - }]>; - create_update_sync_config: { - /** @example 6e7baa88-84dd-4dbc-902a-14522c2984eb */ - destination_id: string; - /** @example 7f72ec07-e5c1-47fd-8cf5-e71dd13873af */ - provider_id: string; - config: components["schemas"]["sync_config_data"]; - }; "webhook-payload": OneOf<[{ /** @enum {unknown} */ type: "SYNC_SUCCESS" | "SYNC_ERROR"; @@ -1422,12 +1316,14 @@ export interface components { type: "standard" | "custom"; name: string; }; + /** @deprecated */ provider_entity_mapping: { /** @example apolla_contact */ entity_id: string; object?: components["schemas"]["standard_object"]; field_mappings?: (components["schemas"]["entity_field_mapping"])[]; }; + /** @deprecated */ connection_entity_mapping: { entity_id: string; object?: components["schemas"]["standard_or_custom_object"]; @@ -1449,6 +1345,7 @@ export interface components { is_additional: boolean; })[]; }; + /** @deprecated */ entity_field_mapping: { /** * @description The name of the field in your application. @@ -1583,7 +1480,7 @@ export interface operations { /** @description Customers */ 200: { content: { - "application/json": (components["schemas"]["customer"])[]; + "application/json": (paths["/customers/%7Bcustomer_id%7D"]["get"]["responses"]["200"]["content"]["application/json"]["schema"])[]; }; }; }; @@ -1615,7 +1512,16 @@ export interface operations { /** @description Customer */ 200: { content: { - "application/json": components["schemas"]["customer"]; + "application/json": { + /** @example d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69 */ + application_id: string; + /** @example your-customers-unique-application-id */ + customer_id: string; + /** @example MyCompany Inc */ + name: string; + /** @example contact@mycompany.com */ + email: string; + }; }; }; }; @@ -1631,74 +1537,7 @@ export interface operations { /** @description Customer */ 200: { content: { - "application/json": components["schemas"]["customer"]; - }; - }; - }; - }; - /** - * List destinations - * @description Get a list of destinations - */ - getDestinations: { - responses: { - /** @description Destinations */ - 200: { - content: { - "application/json": (components["schemas"]["destination"])[]; - }; - }; - }; - }; - /** Create destination */ - createDestination: { - requestBody: { - content: { - "application/json": components["schemas"]["create_destination"]; - }; - }; - responses: { - /** @description Destination created */ - 201: { - content: { - "application/json": components["schemas"]["destination"]; - }; - }; - }; - }; - /** Get destination */ - getDestination: { - parameters: { - path: { - destination_id: string; - }; - }; - responses: { - /** @description Destination */ - 200: { - content: { - "application/json": components["schemas"]["destination"]; - }; - }; - }; - }; - /** Update destination */ - updateDestination: { - parameters: { - path: { - destination_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["update_destination"]; - }; - }; - responses: { - /** @description Destination */ - 200: { - content: { - "application/json": components["schemas"]["destination"]; + "application/json": paths["/customers/%7Bcustomer_id%7D"]["get"]["responses"]["200"]["content"]["application/json"]["schema"]; }; }; }; @@ -2045,89 +1884,6 @@ export interface operations { }; }; }; - /** - * List providers - * @description Get a list of providers - */ - getProviders: { - responses: { - /** @description Providers */ - 200: { - content: { - "application/json": (components["schemas"]["provider"])[]; - }; - }; - }; - }; - /** Create provider */ - createProvider: { - requestBody: { - content: { - "application/json": components["schemas"]["create_provider"]; - }; - }; - responses: { - /** @description Provider created */ - 201: { - content: { - "application/json": components["schemas"]["provider"]; - }; - }; - }; - }; - /** Get provider */ - getProvider: { - parameters: { - path: { - provider_id: string; - }; - }; - responses: { - /** @description Provider */ - 200: { - content: { - "application/json": components["schemas"]["provider"]; - }; - }; - }; - }; - /** Update provider */ - updateProvider: { - parameters: { - path: { - provider_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["update_provider"]; - }; - }; - responses: { - /** @description Provider */ - 200: { - content: { - "application/json": components["schemas"]["provider"]; - }; - }; - }; - }; - /** Delete provider */ - deleteProvider: { - parameters: { - path: { - provider_id: string; - }; - }; - responses: { - /** @description Provider */ - 200: { - content: { - "application/json": components["schemas"]["provider"]; - }; - }; - }; - }; /** * List Sync Configs * @description Get a list of Sync Configs @@ -2142,75 +1898,6 @@ export interface operations { }; }; }; - /** Create Sync Config */ - createSyncConfig: { - requestBody: { - content: { - "application/json": components["schemas"]["create_update_sync_config"]; - }; - }; - responses: { - /** @description SyncConfig created */ - 201: { - content: { - "application/json": components["schemas"]["sync_config"]; - }; - }; - }; - }; - /** Get Sync Config */ - getSyncConfig: { - parameters: { - path: { - sync_config_id: string; - }; - }; - responses: { - /** @description SyncConfig */ - 200: { - content: { - "application/json": components["schemas"]["sync_config"]; - }; - }; - }; - }; - /** Update Sync Config */ - updateSyncConfig: { - parameters: { - path: { - sync_config_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["create_update_sync_config"]; - }; - }; - responses: { - /** @description SyncConfig */ - 200: { - content: { - "application/json": components["schemas"]["sync_config"]; - }; - }; - }; - }; - /** Delete Sync Config */ - deleteSyncConfig: { - parameters: { - path: { - sync_config_id: string; - }; - }; - responses: { - /** @description SyncConfig */ - 200: { - content: { - "application/json": components["schemas"]["sync_config"]; - }; - }; - }; - }; /** Get connection sync config */ getConnectionSyncConfig: { parameters: { @@ -2428,10 +2115,7 @@ export interface operations { /** @description Connection */ 200: { content: { - "application/json": components["schemas"]["connection"] & { - /** @description The id of the user associated with this connection. This is sometimes also known as the owner. */ - user_id?: string; - }; + "application/json": components["schemas"]["connection"]; }; }; }; @@ -2468,7 +2152,10 @@ export interface operations { object_type?: "common" | "standard" | "custom"; /** @description The object to filter by */ object?: string; - /** @description The entity id to filter by */ + /** + * @deprecated + * @description The entity id to filter by + */ entity_id?: string; }; }; @@ -2494,9 +2181,6 @@ export interface operations { requestBody: { content: { "application/json": OneOf<[{ - /** @description The entity id to filter by */ - entity_id: string; - }, { /** * @description The object type to filter by * @example standard @@ -2520,6 +2204,9 @@ export interface operations { * @example contact */ object: string; + }, { + /** @description The entity id to filter by */ + entity_id: string; }]>; }; }; @@ -2543,12 +2230,6 @@ export interface operations { requestBody: { content: { "application/json": OneOf<[{ - /** - * @description The entity id to filter by - * @example cfba6060-c43a-4a63-8a8c-501c6099f8b0 - */ - entity_id: string; - }, { /** * @description The object type to filter by * @example standard @@ -2560,6 +2241,12 @@ export interface operations { * @example contact */ object: string; + }, { + /** + * @description The entity id to filter by + * @example cfba6060-c43a-4a63-8a8c-501c6099f8b0 + */ + entity_id: string; }]>; }; }; @@ -2583,11 +2270,6 @@ export interface operations { requestBody: { content: { "application/json": OneOf<[{ - /** @description The entity id to filter by */ - entity_id: string; - /** @example true */ - perform_full_refresh?: boolean; - }, { /** * @description The object type to filter by * @example standard @@ -2615,6 +2297,11 @@ export interface operations { object: string; /** @example true */ perform_full_refresh?: boolean; + }, { + /** @description The entity id to filter by */ + entity_id: string; + /** @example true */ + perform_full_refresh?: boolean; }]>; }; }; @@ -2645,13 +2332,16 @@ export interface operations { object_type?: "common" | "standard" | "custom"; /** @description The object to filter by */ object?: string; - /** @description The entity id to filter by */ + /** + * @deprecated + * @description The entity id to filter by + */ entity_id?: string; /** @description The status to filter by (case-insensitive) */ status?: string; - /** @description The start time to filter by. Should start with one of [>, <] followed by an ISO 8601 timestamp. */ + /** @description The start time to filter by. Should start with one of [`>`, `<`] followed by an ISO 8601 timestamp. */ start_timestamp?: string; - /** @description The end time to filter by. Should start with [>, <] followed by an ISO 8601 timestamp. */ + /** @description The end time to filter by. Should start with [`>`, `<`] followed by an ISO 8601 timestamp. */ end_timestamp?: string; }; };