@taprootio/integration-sdk 0.0.0-stage → 0.1.2

package/src/openapi-contract.d.ts

@@ -0,0 +1,73 @@
+// Generated by scripts/generate-integration-sdk.mjs from reviewed OpenAPI and webhook schema sources. Do not edit.
+export type BeginIntegrationSyncRequest = { "installationId"?: string; "mode"?: string; "idempotencyKey"?: string; "requestedSyncId"?: string; };
+export type ClaimIntegrationInstallationRequest = { "installationId"?: string; "claimCode"?: string; };
+export type ClaimIntegrationInstallationResponse = { "installation"?: IntegrationInstallation; "credential"?: IntegrationCredential; };
+export type ConfirmIntegrationBundleUploadRequest = { "integrationId"?: string; "uploadId"?: string; };
+export type ConfirmIntegrationMediaUploadRequest = { "installationId"?: string; "uploadId"?: string; };
+export type ConfirmIntegrationMediaUploadResponse = { "image"?: TaprootImage; };
+export type ConfirmIntegrationSettingsHandoffRequest = { "installationId"?: string; "token"?: string; };
+export type ConfirmIntegrationSettingsHandoffResponse = { "userId"?: string; "siteId"?: string; "installationId"?: string; "integrationId"?: string; "credentialId"?: string; "role"?: string; "engagementId"?: string; "expiresAt"?: string; };
+export type DeleteIntegrationContentRequest = { "installationId"?: string; "syncId"?: string; "idempotencyKey"?: string; "key"?: string; };
+export type DeleteIntegrationFragmentRequest = { "installationId"?: string; "placementId"?: string; "configurationRevision"?: number; "expectedFragmentRevision"?: number; "syncId"?: string; "idempotencyKey"?: string; };
+export type FinishIntegrationSyncRequest = { "installationId"?: string; "syncId"?: string; "idempotencyKey"?: string; "summary"?: string; };
+export type ImageOwnershipScope = "IMAGE_OWNERSHIP_SCOPE_UNKNOWN" | "IMAGE_OWNERSHIP_SCOPE_PROFILE" | "IMAGE_OWNERSHIP_SCOPE_SITE" | "IMAGE_OWNERSHIP_SCOPE_ACCOUNT";
+export type ImageProcessingState = "IMAGE_PROCESSING_STATE_UNKNOWN" | "IMAGE_PROCESSING_STATE_PENDING" | "IMAGE_PROCESSING_STATE_COMPLETE" | "IMAGE_PROCESSING_STATE_IN_PROGRESS" | "IMAGE_PROCESSING_STATE_RETRYING" | "IMAGE_PROCESSING_STATE_FAILED";
+export type ImageType = "IMAGE_TYPE_UNKNOWN" | "IMAGE_TYPE_JPEG" | "IMAGE_TYPE_PNG" | "IMAGE_TYPE_WEBP" | "IMAGE_TYPE_GIF";
+export type ImageUrl = { "minWidth"?: number; "url"?: string; };
+export type IntegrationBundle = { "id"?: string; "integrationId"?: string; "contentHash"?: string; "byteLength"?: number; "runtimeMajor"?: number; "url"?: string; "createdAt"?: string; };
+export type IntegrationCredential = { "id"?: string; "displayPrefix"?: string; "status"?: string; "secret"?: string; "isReplay"?: boolean; "createdAt"?: string; "expiresAt"?: string; };
+export type IntegrationInstallation = { "id"?: string; "siteId"?: string; "accountId"?: string; "integrationId"?: string; "status"?: string; "grantedCapabilities"?: Array<string>; "publishPolicy"?: string; "contractVersion"?: string; "sourceKind"?: string; "sourceEngagementId"?: string; "sourceManagingAccountId"?: string; "sourceTerminated"?: boolean; "credentialId"?: string; "revision"?: number; "pathPrefix"?: string; "contentRevision"?: number; "syncCadence"?: string; "syncMinuteOfDay"?: number; "lastSyncedAt"?: string; "lastPublishedAt"?: string; "healthStatus"?: string; "healthReason"?: string; "healthUpdatedAt"?: string; "lastPublishedCandidateRevision"?: number; "lastPublishedDeploymentId"?: string; "pricingOptionId"?: string; "pricingOptionVersion"?: string; "billingStatus"?: string; "entitlementStatus"?: string; "entitlementPeriodEnd"?: string; "billingMutationId"?: string; "billingItemKey"?: string; "priceAmountCents"?: number; "priceCurrency"?: string; "priceCatalogueVersion"?: string; "priceCadence"?: string; "bundle"?: IntegrationBundle; "browserCodeConsented"?: boolean; };
+export type IntegrationInstallationPlacement = { "placementId"?: string; "componentId"?: string; "configurationRevision"?: number; "configJson"?: string; "fragmentRevision"?: number; "fragmentStatus"?: string; };
+export type IntegrationManagedPageContent = { "externalId"?: string; "path"?: string; "title"?: string; "description"?: string; "indexable"?: boolean; "fragments"?: Array<string>; "structuredData"?: Array<string>; "primaryStructuredDataId"?: string; "folder"?: string; "tagIds"?: Array<string>; "includeInNavigation"?: boolean; "publicationDate"?: string; "archiveDate"?: string; "includeInLatestPosts"?: boolean; "contentUpdatedAt"?: string; };
+export type IntegrationPlacementFragmentResult = { "placementId"?: string; "configurationRevision"?: number; "fragmentRevision"?: number; "status"?: string; "changed"?: boolean; };
+export type IntegrationSyncResult = { "syncId"?: string; "status"?: string; "baseRevision"?: number; "candidateRevision"?: number; "changed"?: boolean; };
+export type ListIntegrationPlacementsResponse = { "placements"?: Array<IntegrationInstallationPlacement>; };
+export type PutIntegrationDataDocumentRequest = { "installationId"?: string; "syncId"?: string; "idempotencyKey"?: string; "key"?: string; "json"?: string; };
+export type PutIntegrationFragmentRequest = { "installationId"?: string; "placementId"?: string; "configurationRevision"?: number; "expectedFragmentRevision"?: number; "html"?: string; "structuredData"?: Array<string>; "syncId"?: string; "idempotencyKey"?: string; };
+export type RequestIntegrationBundleUploadRequest = { "integrationId"?: string; "contentHash"?: string; "byteLength"?: number; "runtimeMajor"?: number; };
+export type RequestIntegrationBundleUploadResponse = { "uploadId"?: string; "presignedUrl"?: string; "requiredHeaders"?: { [key: string]: string; }; "expiresAt"?: string; "existingBundle"?: IntegrationBundle; "isDuplicate"?: boolean; };
+export type RequestIntegrationMediaUploadRequest = { "installationId"?: string; "fileName"?: string; "contentType"?: string; "fileSize"?: number; "contentHash"?: string; "width"?: number; "height"?: number; };
+export type RequestIntegrationMediaUploadResponse = { "presignedUrl"?: string; "uploadId"?: string; "isDuplicate"?: boolean; "image"?: TaprootImage; "requiredHeaders"?: { [key: string]: string; }; };
+export type TaprootImage = { "imageId"?: string; "url"?: string; "height"?: number; "width"?: number; "fileSize"?: number; "uploadedName"?: string; "imageType"?: ImageType; "responsiveUrls"?: Array<ImageUrl>; "thumbHash"?: string; "processingState"?: ImageProcessingState; "ownershipScope"?: ImageOwnershipScope; "siteId"?: string; };
+export type UpsertIntegrationPageRequest = { "installationId"?: string; "syncId"?: string; "idempotencyKey"?: string; "page"?: IntegrationManagedPageContent; };
+export type ValidateIntegrationInstallationResponse = { "valid"?: boolean; "installation"?: IntegrationInstallation; "entitlementStatus"?: string; "entitlementEnabled"?: boolean; "writesEnabled"?: boolean; "code"?: string; };
+export interface IntegrationOpenApiOperationMap {
+  "claimInstallation": { request: ClaimIntegrationInstallationRequest; response: ClaimIntegrationInstallationResponse; };
+  "validateInstallation": { request: undefined; response: ValidateIntegrationInstallationResponse; };
+  "createSync": { request: BeginIntegrationSyncRequest; response: IntegrationSyncResult; };
+  "putManagedPage": { request: UpsertIntegrationPageRequest; response: IntegrationSyncResult; };
+  "deleteManagedPage": { request: DeleteIntegrationContentRequest; response: IntegrationSyncResult; };
+  "putDataDocument": { request: PutIntegrationDataDocumentRequest; response: IntegrationSyncResult; };
+  "deleteDataDocument": { request: DeleteIntegrationContentRequest; response: IntegrationSyncResult; };
+  "completeSync": { request: FinishIntegrationSyncRequest; response: IntegrationSyncResult; };
+  "abortSync": { request: FinishIntegrationSyncRequest; response: IntegrationSyncResult; };
+  "requestMediaUpload": { request: RequestIntegrationMediaUploadRequest; response: RequestIntegrationMediaUploadResponse; };
+  "confirmMediaUpload": { request: ConfirmIntegrationMediaUploadRequest; response: ConfirmIntegrationMediaUploadResponse; };
+  "listPlacements": { request: undefined; response: ListIntegrationPlacementsResponse; };
+  "putFragment": { request: PutIntegrationFragmentRequest; response: IntegrationPlacementFragmentResult; };
+  "deleteFragment": { request: DeleteIntegrationFragmentRequest; response: IntegrationPlacementFragmentResult; };
+  "requestBundleUpload": { request: RequestIntegrationBundleUploadRequest; response: RequestIntegrationBundleUploadResponse; };
+  "confirmBundleUpload": { request: ConfirmIntegrationBundleUploadRequest; response: IntegrationBundle; };
+  "confirmHandoff": { request: ConfirmIntegrationSettingsHandoffRequest; response: ConfirmIntegrationSettingsHandoffResponse; };
+}
+export interface GeneratedWebhookEventMap {
+  "installation.created": { "id": string; "type": string; "version": "1"; "occurredAt": string; "integrationId": string; "installationId": string; "siteId": string; "data": unknown; } & { "type": "installation.created"; "data": { "installation": { "status": string; "revision": number; "grantedCapabilities": Array<string>; "publishPolicy": "auto" | "stage"; "contractVersion": string; "sourceKind": "owner" | "engagement"; "sourceEngagementId": string | null; "sourceTerminationReason": string | null; }; "claimCode": string; "claimExpiresAt": string; }; };
+  "installation.resumed": { "id": string; "type": string; "version": "1"; "occurredAt": string; "integrationId": string; "installationId": string; "siteId": string; "data": unknown; } & { "type": "installation.resumed"; "data": { "status": string; "revision": number; "grantedCapabilities": Array<string>; "publishPolicy": "auto" | "stage"; "contractVersion": string; "sourceKind": "owner" | "engagement"; "sourceEngagementId": string | null; "sourceTerminationReason": string | null; }; };
+  "installation.suspended": { "id": string; "type": string; "version": "1"; "occurredAt": string; "integrationId": string; "installationId": string; "siteId": string; "data": unknown; } & { "type": "installation.suspended"; "data": { "status": string; "revision": number; "grantedCapabilities": Array<string>; "publishPolicy": "auto" | "stage"; "contractVersion": string; "sourceKind": "owner" | "engagement"; "sourceEngagementId": string | null; "sourceTerminationReason": string | null; }; };
+  "installation.uninstalled": { "id": string; "type": string; "version": "1"; "occurredAt": string; "integrationId": string; "installationId": string; "siteId": string; "data": unknown; } & { "type": "installation.uninstalled"; "data": { "status": string; "revision": number; "grantedCapabilities": Array<string>; "publishPolicy": "auto" | "stage"; "contractVersion": string; "sourceKind": "owner" | "engagement"; "sourceEngagementId": string | null; "sourceTerminationReason": string | null; }; };
+  "installation.updated": { "id": string; "type": string; "version": "1"; "occurredAt": string; "integrationId": string; "installationId": string; "siteId": string; "data": unknown; } & { "type": "installation.updated"; "data": { "status": string; "revision": number; "grantedCapabilities": Array<string>; "publishPolicy": "auto" | "stage"; "contractVersion": string; "sourceKind": "owner" | "engagement"; "sourceEngagementId": string | null; "sourceTerminationReason": string | null; }; };
+  "page.deleted": { "id": string; "type": string; "version": "1"; "occurredAt": string; "integrationId": string; "installationId": string; "siteId": string; "data": unknown; } & { "type": "page.deleted"; "data": { "pageId": string; "externalId": string; "revision": number; "url": string; }; };
+  "page.published": { "id": string; "type": string; "version": "1"; "occurredAt": string; "integrationId": string; "installationId": string; "siteId": string; "data": unknown; } & { "type": "page.published"; "data": { "pageId": string; "externalId": string; "publishedRevision": number; "url": string; }; };
+  "ping": { "id": string; "type": string; "version": "1"; "occurredAt": string; "integrationId": string; "installationId": string; "siteId": string; "data": unknown; } & { "type": "ping"; "data": { "purpose": string; }; };
+  "placement.created": { "id": string; "type": string; "version": "1"; "occurredAt": string; "integrationId": string; "installationId": string; "siteId": string; "data": unknown; } & { "type": "placement.created"; "data": { "placementId": string; "componentId": string; "placementRevision": number; "config": unknown; }; };
+  "placement.deleted": { "id": string; "type": string; "version": "1"; "occurredAt": string; "integrationId": string; "installationId": string; "siteId": string; "data": unknown; } & { "type": "placement.deleted"; "data": { "placementId": string; "componentId": string; "placementRevision": number; "config": unknown; }; };
+  "placement.updated": { "id": string; "type": string; "version": "1"; "occurredAt": string; "integrationId": string; "installationId": string; "siteId": string; "data": unknown; } & { "type": "placement.updated"; "data": { "placementId": string; "componentId": string; "placementRevision": number; "config": unknown; }; };
+  "publish.completed": { "id": string; "type": string; "version": "1"; "occurredAt": string; "integrationId": string; "installationId": string; "siteId": string; "data": unknown; } & { "type": "publish.completed"; "data": { "deploymentId": string; "candidates": Array<{ "candidateId": string; "revision": number; }>; }; };
+  "publish.failed": { "id": string; "type": string; "version": "1"; "occurredAt": string; "integrationId": string; "installationId": string; "siteId": string; "data": unknown; } & { "type": "publish.failed"; "data": { "deploymentId": string; "candidateIds": Array<string>; "code": string; }; };
+  "sync.requested": { "id": string; "type": string; "version": "1"; "occurredAt": string; "integrationId": string; "installationId": string; "siteId": string; "data": unknown; } & { "type": "sync.requested"; "data": { "reason": "scheduled" | "owner" | "placement_changed" | "reconcile"; "syncId": string; "candidateIds": Array<string>; }; };
+}
+export type GeneratedWebhookEventType = keyof GeneratedWebhookEventMap;
+export type GeneratedWebhookEvent = GeneratedWebhookEventMap[GeneratedWebhookEventType];
+export declare const INTEGRATION_OPENAPI_OPERATIONS: Readonly<Record<keyof IntegrationOpenApiOperationMap, { operationId: string; method: string; path: string; credential: "installation" | "publisher"; retry: "never" | "safe" | "idempotency"; requestSchema?: string; responseSchema: string }>>;
+export declare const INTEGRATION_OPENAPI_SCHEMAS: Readonly<Record<string, unknown>>;
+export declare const INTEGRATION_WEBHOOK_EVENTS: Readonly<Record<GeneratedWebhookEventType, { schema: string; example: string }>>;