@augstash/sdk 0.2.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generated/src/apis/AdAccountApi.d.ts +13 -13
- package/dist/generated/src/apis/AdAccountApi.js +8 -8
- package/dist/generated/src/apis/AdminEmailReputationApi.d.ts +12 -12
- package/dist/generated/src/apis/AdminEmailReputationApi.js +6 -6
- package/dist/generated/src/apis/AdminFirstPartyAppApi.d.ts +49 -20
- package/dist/generated/src/apis/AdminFirstPartyAppApi.js +51 -10
- package/dist/generated/src/apis/AdminFxRateApi.d.ts +4 -4
- package/dist/generated/src/apis/AdminFxRateApi.js +2 -2
- package/dist/generated/src/apis/AdminImpersonationApi.d.ts +16 -16
- package/dist/generated/src/apis/AdminImpersonationApi.js +8 -8
- package/dist/generated/src/apis/AdminOperatorApi.d.ts +12 -12
- package/dist/generated/src/apis/AdminOperatorApi.js +6 -6
- package/dist/generated/src/apis/AdminPricingApi.d.ts +16 -16
- package/dist/generated/src/apis/AdminPricingApi.js +8 -8
- package/dist/generated/src/apis/AdminProviderHealthApi.d.ts +4 -4
- package/dist/generated/src/apis/AdminProviderHealthApi.js +2 -2
- package/dist/generated/src/apis/AdminRateCardApi.d.ts +16 -16
- package/dist/generated/src/apis/AdminRateCardApi.js +8 -8
- package/dist/generated/src/apis/AdminRevenueApi.d.ts +12 -12
- package/dist/generated/src/apis/AdminRevenueApi.js +6 -6
- package/dist/generated/src/apis/AdminTenantApi.d.ts +16 -16
- package/dist/generated/src/apis/AdminTenantApi.js +8 -8
- package/dist/generated/src/apis/AdminTenantPurgeApi.d.ts +57 -0
- package/dist/generated/src/apis/AdminTenantPurgeApi.js +103 -0
- package/dist/generated/src/apis/AdminWalletApi.d.ts +16 -16
- package/dist/generated/src/apis/AdminWalletApi.js +8 -8
- package/dist/generated/src/apis/AdminWhatsAppNumberApi.d.ts +8 -8
- package/dist/generated/src/apis/AdminWhatsAppNumberApi.js +4 -4
- package/dist/generated/src/apis/AgentLanguageApi.d.ts +5 -5
- package/dist/generated/src/apis/AgentLanguageApi.js +4 -4
- package/dist/generated/src/apis/AiApi.d.ts +5 -5
- package/dist/generated/src/apis/AiApi.js +4 -4
- package/dist/generated/src/apis/ApiKeyApi.d.ts +32 -1
- package/dist/generated/src/apis/ApiKeyApi.js +46 -0
- package/dist/generated/src/apis/AuditApi.d.ts +4 -4
- package/dist/generated/src/apis/AuditApi.js +2 -2
- package/dist/generated/src/apis/AuthMeApi.d.ts +4 -4
- package/dist/generated/src/apis/AuthMeApi.js +3 -3
- package/dist/generated/src/apis/AutomationApi.d.ts +30 -1
- package/dist/generated/src/apis/AutomationApi.js +42 -0
- package/dist/generated/src/apis/AutomationEventApi.d.ts +102 -0
- package/dist/generated/src/apis/AutomationEventApi.js +155 -0
- package/dist/generated/src/apis/AutomationIdentityApi.d.ts +49 -0
- package/dist/generated/src/apis/AutomationIdentityApi.js +91 -0
- package/dist/generated/src/apis/AutomationSubscriptionApi.d.ts +111 -0
- package/dist/generated/src/apis/AutomationSubscriptionApi.js +179 -0
- package/dist/generated/src/apis/BillingApi.d.ts +30 -1
- package/dist/generated/src/apis/BillingApi.js +42 -0
- package/dist/generated/src/apis/CdpApi.d.ts +144 -0
- package/dist/generated/src/apis/CdpApi.js +230 -0
- package/dist/generated/src/apis/CdpWebhookApi.d.ts +58 -0
- package/dist/generated/src/apis/CdpWebhookApi.js +102 -0
- package/dist/generated/src/apis/ChatOpsApi.d.ts +329 -0
- package/dist/generated/src/apis/ChatOpsApi.js +498 -0
- package/dist/generated/src/apis/ChatOpsInteractiveApi.d.ts +66 -0
- package/dist/generated/src/apis/ChatOpsInteractiveApi.js +103 -0
- package/dist/generated/src/apis/ContactSyncApi.d.ts +229 -0
- package/dist/generated/src/apis/ContactSyncApi.js +352 -0
- package/dist/generated/src/apis/ContactSyncWebhookApi.d.ts +87 -0
- package/dist/generated/src/apis/ContactSyncWebhookApi.js +143 -0
- package/dist/generated/src/apis/FlowDataExchangeApi.d.ts +5 -5
- package/dist/generated/src/apis/FlowDataExchangeApi.js +3 -3
- package/dist/generated/src/apis/HelpdeskApi.d.ts +200 -0
- package/dist/generated/src/apis/HelpdeskApi.js +314 -0
- package/dist/generated/src/apis/HubSpotApi.d.ts +188 -0
- package/dist/generated/src/apis/HubSpotApi.js +292 -0
- package/dist/generated/src/apis/IntegrationConnectionApi.d.ts +111 -0
- package/dist/generated/src/apis/IntegrationConnectionApi.js +176 -0
- package/dist/generated/src/apis/MessageAnalyticsApi.d.ts +4 -4
- package/dist/generated/src/apis/MessageAnalyticsApi.js +2 -2
- package/dist/generated/src/apis/NoCodeApi.d.ts +395 -0
- package/dist/generated/src/apis/NoCodeApi.js +592 -0
- package/dist/generated/src/apis/NotificationApi.d.ts +8 -2
- package/dist/generated/src/apis/NotificationApi.js +8 -2
- package/dist/generated/src/apis/OrderNotificationApi.d.ts +20 -44
- package/dist/generated/src/apis/OrderNotificationApi.js +17 -39
- package/dist/generated/src/apis/PlanUsageApi.d.ts +49 -0
- package/dist/generated/src/apis/PlanUsageApi.js +91 -0
- package/dist/generated/src/apis/SalesforceApi.d.ts +186 -0
- package/dist/generated/src/apis/SalesforceApi.js +287 -0
- package/dist/generated/src/apis/SalesforceOAuthCallbackApi.d.ts +58 -0
- package/dist/generated/src/apis/SalesforceOAuthCallbackApi.js +101 -0
- package/dist/generated/src/apis/SamlApi.d.ts +144 -0
- package/dist/generated/src/apis/SamlApi.js +242 -0
- package/dist/generated/src/apis/ScimDiscoveryApi.d.ts +118 -0
- package/dist/generated/src/apis/ScimDiscoveryApi.js +158 -0
- package/dist/generated/src/apis/ScimGroupApi.d.ts +204 -0
- package/dist/generated/src/apis/ScimGroupApi.js +312 -0
- package/dist/generated/src/apis/ScimUserApi.d.ts +204 -0
- package/dist/generated/src/apis/ScimUserApi.js +312 -0
- package/dist/generated/src/apis/SettingsApi.d.ts +4 -1
- package/dist/generated/src/apis/SettingsApi.js +4 -1
- package/dist/generated/src/apis/ShipmentApi.d.ts +200 -0
- package/dist/generated/src/apis/ShipmentApi.js +307 -0
- package/dist/generated/src/apis/ShipmentWebhookApi.d.ts +58 -0
- package/dist/generated/src/apis/ShipmentWebhookApi.js +102 -0
- package/dist/generated/src/apis/SsoSettingsApi.d.ts +159 -0
- package/dist/generated/src/apis/SsoSettingsApi.js +242 -0
- package/dist/generated/src/apis/StandaloneAuthApi.d.ts +5 -5
- package/dist/generated/src/apis/StandaloneAuthApi.js +4 -4
- package/dist/generated/src/apis/StoreApi.d.ts +167 -0
- package/dist/generated/src/apis/StoreApi.js +259 -0
- package/dist/generated/src/apis/TallyApi.d.ts +134 -0
- package/dist/generated/src/apis/TallyApi.js +215 -0
- package/dist/generated/src/apis/TemplateApi.d.ts +8 -8
- package/dist/generated/src/apis/TemplateApi.js +4 -4
- package/dist/generated/src/apis/WabaApi.d.ts +29 -0
- package/dist/generated/src/apis/WabaApi.js +40 -0
- package/dist/generated/src/apis/WabaPhoneNumberApi.d.ts +5 -5
- package/dist/generated/src/apis/WabaPhoneNumberApi.js +4 -4
- package/dist/generated/src/apis/ZohoBooksApi.d.ts +182 -0
- package/dist/generated/src/apis/ZohoBooksApi.js +281 -0
- package/dist/generated/src/apis/ZohoCrmApi.d.ts +159 -0
- package/dist/generated/src/apis/ZohoCrmApi.js +247 -0
- package/dist/generated/src/apis/ZohoOAuthCallbackApi.d.ts +60 -0
- package/dist/generated/src/apis/ZohoOAuthCallbackApi.js +104 -0
- package/dist/generated/src/apis/index.d.ts +29 -0
- package/dist/generated/src/apis/index.js +29 -0
- package/dist/generated/src/models/AbTestVariantRequest.d.ts +1 -1
- package/dist/generated/src/models/AbTestVariantRequest.js +3 -1
- package/dist/generated/src/models/AdAccountConnectionResponse.d.ts +12 -0
- package/dist/generated/src/models/AdAccountConnectionResponse.js +4 -0
- package/dist/generated/src/models/AdminStartImpersonationRequest.d.ts +1 -1
- package/dist/generated/src/models/AdminStartImpersonationRequest.js +3 -1
- package/dist/generated/src/models/AdminTenantPurgeReceiptResponse.d.ts +80 -0
- package/dist/generated/src/models/AdminTenantPurgeReceiptResponse.js +64 -0
- package/dist/generated/src/models/AdminTenantPurgeRequest.d.ts +38 -0
- package/dist/generated/src/models/AdminTenantPurgeRequest.js +54 -0
- package/dist/generated/src/models/ApiKeyResponse.d.ts +7 -0
- package/dist/generated/src/models/ApiKeyResponse.js +3 -0
- package/dist/generated/src/models/AutoRechargeRequest.d.ts +1 -1
- package/dist/generated/src/models/AutoRechargeRequest.js +3 -1
- package/dist/generated/src/models/AutomationApiTriggerRequest.d.ts +64 -0
- package/dist/generated/src/models/AutomationApiTriggerRequest.js +58 -0
- package/dist/generated/src/models/AutomationApiTriggerResponse.d.ts +38 -0
- package/dist/generated/src/models/AutomationApiTriggerResponse.js +50 -0
- package/dist/generated/src/models/AutomationCreateFlowRequest.d.ts +5 -0
- package/dist/generated/src/models/AutomationCreateFlowRequest.js +6 -1
- package/dist/generated/src/models/AutomationFlowResponse.d.ts +5 -0
- package/dist/generated/src/models/AutomationFlowResponse.js +6 -1
- package/dist/generated/src/models/AutomationFlowSummaryResponse.d.ts +5 -0
- package/dist/generated/src/models/AutomationFlowSummaryResponse.js +6 -1
- package/dist/generated/src/models/AutomationIdentityResponse.d.ts +56 -0
- package/dist/generated/src/models/AutomationIdentityResponse.js +56 -0
- package/dist/generated/src/models/AutomationNode.d.ts +18 -0
- package/dist/generated/src/models/AutomationNode.js +9 -1
- package/dist/generated/src/models/AutomationSubscriptionResponse.d.ts +78 -0
- package/dist/generated/src/models/AutomationSubscriptionResponse.js +78 -0
- package/dist/generated/src/models/AutomationUpdateFlowRequest.d.ts +5 -0
- package/dist/generated/src/models/AutomationUpdateFlowRequest.js +6 -1
- package/dist/generated/src/models/BotIntegrationFamilyResponse.d.ts +58 -0
- package/dist/generated/src/models/BotIntegrationFamilyResponse.js +58 -0
- package/dist/generated/src/models/BotIntegrationOperationResponse.d.ts +63 -0
- package/dist/generated/src/models/BotIntegrationOperationResponse.js +59 -0
- package/dist/generated/src/models/BotIntegrationParamResponse.d.ts +50 -0
- package/dist/generated/src/models/BotIntegrationParamResponse.js +54 -0
- package/dist/generated/src/models/BotIntegrationVendorResponse.d.ts +44 -0
- package/dist/generated/src/models/BotIntegrationVendorResponse.js +52 -0
- package/dist/generated/src/models/BotNodeTypeResponse.d.ts +7 -0
- package/dist/generated/src/models/BotNodeTypeResponse.js +3 -0
- package/dist/generated/src/models/BotSimulateRequest.d.ts +6 -0
- package/dist/generated/src/models/BotSimulateRequest.js +2 -0
- package/dist/generated/src/models/Candidate.d.ts +6 -0
- package/dist/generated/src/models/Candidate.js +2 -0
- package/dist/generated/src/models/CarrierConnectionResponse.d.ts +68 -0
- package/dist/generated/src/models/CarrierConnectionResponse.js +60 -0
- package/dist/generated/src/models/CatalogOrderResponse.d.ts +3 -0
- package/dist/generated/src/models/CatalogOrderResponse.js +4 -1
- package/dist/generated/src/models/CatalogProductResponse.d.ts +3 -0
- package/dist/generated/src/models/CatalogProductResponse.js +3 -0
- package/dist/generated/src/models/CdpInboundEventResponse.d.ts +74 -0
- package/dist/generated/src/models/CdpInboundEventResponse.js +62 -0
- package/dist/generated/src/models/CdpVendorResponse.d.ts +104 -0
- package/dist/generated/src/models/CdpVendorResponse.js +72 -0
- package/dist/generated/src/models/CertificateSummary.d.ts +50 -0
- package/dist/generated/src/models/CertificateSummary.js +54 -0
- package/dist/generated/src/models/ChangePlanRequest.d.ts +58 -0
- package/dist/generated/src/models/ChangePlanRequest.js +71 -0
- package/dist/generated/src/models/ChannelAccountBinding.d.ts +52 -0
- package/dist/generated/src/models/ChannelAccountBinding.js +68 -0
- package/dist/generated/src/models/ChatOpsAlertTypeResponse.d.ts +50 -0
- package/dist/generated/src/models/ChatOpsAlertTypeResponse.js +54 -0
- package/dist/generated/src/models/ChatOpsIdentityResponse.d.ts +62 -0
- package/dist/generated/src/models/ChatOpsIdentityResponse.js +58 -0
- package/dist/generated/src/models/ChatOpsRouteResponse.d.ts +80 -0
- package/dist/generated/src/models/ChatOpsRouteResponse.js +64 -0
- package/dist/generated/src/models/ChatOpsVendorResponse.d.ts +86 -0
- package/dist/generated/src/models/ChatOpsVendorResponse.js +66 -0
- package/dist/generated/src/models/ConnectCarrierRequest.d.ts +34 -0
- package/dist/generated/src/models/ConnectCarrierRequest.js +50 -0
- package/dist/generated/src/models/ConnectCdpRequest.d.ts +40 -0
- package/dist/generated/src/models/ConnectCdpRequest.js +52 -0
- package/dist/generated/src/models/ConnectChatOpsRequest.d.ts +40 -0
- package/dist/generated/src/models/ConnectChatOpsRequest.js +50 -0
- package/dist/generated/src/models/ConnectContactSyncRequest.d.ts +40 -0
- package/dist/generated/src/models/ConnectContactSyncRequest.js +52 -0
- package/dist/generated/src/models/ConnectHelpdeskRequest.d.ts +34 -0
- package/dist/generated/src/models/ConnectHelpdeskRequest.js +50 -0
- package/dist/generated/src/models/ConnectHubSpotRequest.d.ts +40 -0
- package/dist/generated/src/models/ConnectHubSpotRequest.js +52 -0
- package/dist/generated/src/models/ConnectNoCodeRequest.d.ts +40 -0
- package/dist/generated/src/models/ConnectNoCodeRequest.js +50 -0
- package/dist/generated/src/models/ConnectStoreRequest.d.ts +40 -0
- package/dist/generated/src/models/ConnectStoreRequest.js +52 -0
- package/dist/generated/src/models/ConnectTallyRequest.d.ts +32 -0
- package/dist/generated/src/models/ConnectTallyRequest.js +50 -0
- package/dist/generated/src/models/ContactSyncListResponse.d.ts +80 -0
- package/dist/generated/src/models/ContactSyncListResponse.js +64 -0
- package/dist/generated/src/models/ContactSyncRunResponse.d.ts +74 -0
- package/dist/generated/src/models/ContactSyncRunResponse.js +62 -0
- package/dist/generated/src/models/ContactSyncVendorResponse.d.ts +110 -0
- package/dist/generated/src/models/ContactSyncVendorResponse.js +74 -0
- package/dist/generated/src/models/CreateApiKeyRequest.d.ts +7 -0
- package/dist/generated/src/models/CreateApiKeyRequest.js +3 -0
- package/dist/generated/src/models/CreateSubscriptionRequest.d.ts +60 -0
- package/dist/generated/src/models/CreateSubscriptionRequest.js +76 -0
- package/dist/generated/src/models/CreateTicketRequest.d.ts +32 -0
- package/dist/generated/src/models/CreateTicketRequest.js +50 -0
- package/dist/generated/src/models/CreateWebhookEndpointRequest.d.ts +6 -0
- package/dist/generated/src/models/CreateWebhookEndpointRequest.js +6 -0
- package/dist/generated/src/models/CreateWebhookEndpointResponse.d.ts +6 -0
- package/dist/generated/src/models/CreateWebhookEndpointResponse.js +6 -0
- package/dist/generated/src/models/CreateWebhookTriggerRequest.d.ts +3 -2
- package/dist/generated/src/models/CreateWebhookTriggerRequest.js +2 -1
- package/dist/generated/src/models/CreateWebhookTriggerResponse.d.ts +1 -0
- package/dist/generated/src/models/CreateWebhookTriggerResponse.js +2 -1
- package/dist/generated/src/models/CursorPageCdpInboundEventResponse.d.ts +45 -0
- package/dist/generated/src/models/CursorPageCdpInboundEventResponse.js +53 -0
- package/dist/generated/src/models/CursorPageShipmentSummaryResponse.d.ts +45 -0
- package/dist/generated/src/models/CursorPageShipmentSummaryResponse.js +53 -0
- package/dist/generated/src/models/Email.d.ts +44 -0
- package/dist/generated/src/models/Email.js +52 -0
- package/dist/generated/src/models/EmailAbTestVariantRequest.d.ts +1 -1
- package/dist/generated/src/models/EmailAbTestVariantRequest.js +3 -1
- package/dist/generated/src/models/FirstPartyApp.d.ts +25 -1
- package/dist/generated/src/models/FirstPartyApp.js +8 -0
- package/dist/generated/src/models/FlowNode.d.ts +10 -0
- package/dist/generated/src/models/FlowNode.js +7 -1
- package/dist/generated/src/models/GroupRef.d.ts +38 -0
- package/dist/generated/src/models/GroupRef.js +50 -0
- package/dist/generated/src/models/HelpdeskTicketResponse.d.ts +100 -0
- package/dist/generated/src/models/HelpdeskTicketResponse.js +83 -0
- package/dist/generated/src/models/HelpdeskVendorResponse.d.ts +122 -0
- package/dist/generated/src/models/HelpdeskVendorResponse.js +89 -0
- package/dist/generated/src/models/HubSpotCompanyResponse.d.ts +68 -0
- package/dist/generated/src/models/HubSpotCompanyResponse.js +60 -0
- package/dist/generated/src/models/HubSpotDealResponse.d.ts +68 -0
- package/dist/generated/src/models/HubSpotDealResponse.js +60 -0
- package/dist/generated/src/models/HubSpotRunResponse.d.ts +92 -0
- package/dist/generated/src/models/HubSpotRunResponse.js +68 -0
- package/dist/generated/src/models/HubSpotStatusResponse.d.ts +128 -0
- package/dist/generated/src/models/HubSpotStatusResponse.js +80 -0
- package/dist/generated/src/models/IntegrationConnectionResponse.d.ts +95 -0
- package/dist/generated/src/models/IntegrationConnectionResponse.js +75 -0
- package/dist/generated/src/models/IntegrationEventPage.d.ts +45 -0
- package/dist/generated/src/models/IntegrationEventPage.js +53 -0
- package/dist/generated/src/models/IntegrationEventResponse.d.ts +78 -0
- package/dist/generated/src/models/IntegrationEventResponse.js +78 -0
- package/dist/generated/src/models/IntegrationEventTypeResponse.d.ts +73 -0
- package/dist/generated/src/models/IntegrationEventTypeResponse.js +77 -0
- package/dist/generated/src/models/IntegrationStepSpec.d.ts +64 -0
- package/dist/generated/src/models/IntegrationStepSpec.js +58 -0
- package/dist/generated/src/models/IntegrationSummaryResponse.d.ts +27 -0
- package/dist/generated/src/models/IntegrationSummaryResponse.js +15 -0
- package/dist/generated/src/models/LimitUsage.d.ts +68 -0
- package/dist/generated/src/models/LimitUsage.js +60 -0
- package/dist/generated/src/models/LinkChatOpsIdentityRequest.d.ts +32 -0
- package/dist/generated/src/models/LinkChatOpsIdentityRequest.js +50 -0
- package/dist/generated/src/models/ListResponseScimGroupResource.d.ts +57 -0
- package/dist/generated/src/models/ListResponseScimGroupResource.js +57 -0
- package/dist/generated/src/models/ListResponseScimUserResource.d.ts +57 -0
- package/dist/generated/src/models/ListResponseScimUserResource.js +57 -0
- package/dist/generated/src/models/MarkTourStepSeenRequest.d.ts +1 -1
- package/dist/generated/src/models/MarkTourStepSeenRequest.js +3 -1
- package/dist/generated/src/models/Member.d.ts +38 -0
- package/dist/generated/src/models/Member.js +50 -0
- package/dist/generated/src/models/Meta.d.ts +50 -0
- package/dist/generated/src/models/Meta.js +54 -0
- package/dist/generated/src/models/ModuleActivity.d.ts +6 -0
- package/dist/generated/src/models/ModuleActivity.js +2 -0
- package/dist/generated/src/models/MuteEventTypeRequest.d.ts +4 -1
- package/dist/generated/src/models/MuteEventTypeRequest.js +7 -2
- package/dist/generated/src/models/Name.d.ts +44 -0
- package/dist/generated/src/models/Name.js +52 -0
- package/dist/generated/src/models/NoCodeColumnMapping.d.ts +62 -0
- package/dist/generated/src/models/NoCodeColumnMapping.js +74 -0
- package/dist/generated/src/models/NoCodeImportResponse.d.ts +167 -0
- package/dist/generated/src/models/NoCodeImportResponse.js +103 -0
- package/dist/generated/src/models/NoCodeImportRunResponse.d.ts +40 -0
- package/dist/generated/src/models/NoCodeImportRunResponse.js +52 -0
- package/dist/generated/src/models/NoCodePreviewRequest.d.ts +77 -0
- package/dist/generated/src/models/NoCodePreviewRequest.js +75 -0
- package/dist/generated/src/models/NoCodePreviewResponse.d.ts +66 -0
- package/dist/generated/src/models/NoCodePreviewResponse.js +60 -0
- package/dist/generated/src/models/NoCodeResultSinkResponse.d.ts +80 -0
- package/dist/generated/src/models/NoCodeResultSinkResponse.js +64 -0
- package/dist/generated/src/models/NoCodeSourceResponse.d.ts +50 -0
- package/dist/generated/src/models/NoCodeSourceResponse.js +54 -0
- package/dist/generated/src/models/NoCodeVendorResponse.d.ts +86 -0
- package/dist/generated/src/models/NoCodeVendorResponse.js +66 -0
- package/dist/generated/src/models/NotificationPreferenceResponse.d.ts +3 -0
- package/dist/generated/src/models/NotificationPreferenceResponse.js +4 -1
- package/dist/generated/src/models/NotificationResponse.d.ts +3 -0
- package/dist/generated/src/models/NotificationResponse.js +4 -1
- package/dist/generated/src/models/Operation.d.ts +44 -0
- package/dist/generated/src/models/Operation.js +52 -0
- package/dist/generated/src/models/OrderNotificationDefaultResponse.d.ts +24 -0
- package/dist/generated/src/models/OrderNotificationDefaultResponse.js +16 -1
- package/dist/generated/src/models/OrderNotificationLogResponse.d.ts +24 -0
- package/dist/generated/src/models/OrderNotificationLogResponse.js +16 -1
- package/dist/generated/src/models/OrderNotificationRuleResponse.d.ts +24 -0
- package/dist/generated/src/models/OrderNotificationRuleResponse.js +16 -1
- package/dist/generated/src/models/PageInvoiceResponse.d.ts +12 -12
- package/dist/generated/src/models/PageInvoiceResponse.js +6 -6
- package/dist/generated/src/models/PageResponseAutomationSubscriptionResponse.d.ts +57 -0
- package/dist/generated/src/models/PageResponseAutomationSubscriptionResponse.js +57 -0
- package/dist/generated/src/models/PageResponseHelpdeskTicketResponse.d.ts +57 -0
- package/dist/generated/src/models/PageResponseHelpdeskTicketResponse.js +57 -0
- package/dist/generated/src/models/PageResponseHubSpotCompanyResponse.d.ts +57 -0
- package/dist/generated/src/models/PageResponseHubSpotCompanyResponse.js +57 -0
- package/dist/generated/src/models/PageResponseHubSpotDealResponse.d.ts +57 -0
- package/dist/generated/src/models/PageResponseHubSpotDealResponse.js +57 -0
- package/dist/generated/src/models/PageResponseSalesforceAccountResponse.d.ts +57 -0
- package/dist/generated/src/models/PageResponseSalesforceAccountResponse.js +57 -0
- package/dist/generated/src/models/PageResponseSalesforceOpportunityResponse.d.ts +57 -0
- package/dist/generated/src/models/PageResponseSalesforceOpportunityResponse.js +57 -0
- package/dist/generated/src/models/PageResponseTallyVoucherResponse.d.ts +57 -0
- package/dist/generated/src/models/PageResponseTallyVoucherResponse.js +57 -0
- package/dist/generated/src/models/PageResponseZohoBooksInvoiceResponse.d.ts +57 -0
- package/dist/generated/src/models/PageResponseZohoBooksInvoiceResponse.js +57 -0
- package/dist/generated/src/models/PageResponseZohoCrmDealResponse.d.ts +57 -0
- package/dist/generated/src/models/PageResponseZohoCrmDealResponse.js +57 -0
- package/dist/generated/src/models/PageTaxRecordResponse.d.ts +12 -12
- package/dist/generated/src/models/PageTaxRecordResponse.js +6 -6
- package/dist/generated/src/models/PageWaIvrCallbackResponse.d.ts +12 -12
- package/dist/generated/src/models/PageWaIvrCallbackResponse.js +6 -6
- package/dist/generated/src/models/PageWalletLedgerEntryResponse.d.ts +12 -12
- package/dist/generated/src/models/PageWalletLedgerEntryResponse.js +6 -6
- package/dist/generated/src/models/PageableObject.d.ts +10 -10
- package/dist/generated/src/models/PageableObject.js +8 -8
- package/dist/generated/src/models/PatchRequest.d.ts +39 -0
- package/dist/generated/src/models/PatchRequest.js +51 -0
- package/dist/generated/src/models/PlanCardResponse.d.ts +68 -0
- package/dist/generated/src/models/PlanCardResponse.js +28 -1
- package/dist/generated/src/models/PlanUsageResponse.d.ts +39 -0
- package/dist/generated/src/models/PlanUsageResponse.js +51 -0
- package/dist/generated/src/models/PublicTenantResponse.d.ts +12 -0
- package/dist/generated/src/models/PublicTenantResponse.js +4 -0
- package/dist/generated/src/models/SalesforceAccountResponse.d.ts +68 -0
- package/dist/generated/src/models/SalesforceAccountResponse.js +60 -0
- package/dist/generated/src/models/SalesforceAuthorizeUrlResponse.d.ts +50 -0
- package/dist/generated/src/models/SalesforceAuthorizeUrlResponse.js +54 -0
- package/dist/generated/src/models/SalesforceOpportunityResponse.d.ts +80 -0
- package/dist/generated/src/models/SalesforceOpportunityResponse.js +64 -0
- package/dist/generated/src/models/SalesforceRunResponse.d.ts +104 -0
- package/dist/generated/src/models/SalesforceRunResponse.js +72 -0
- package/dist/generated/src/models/SalesforceStatusResponse.d.ts +170 -0
- package/dist/generated/src/models/SalesforceStatusResponse.js +94 -0
- package/dist/generated/src/models/SamlTicketExchangeRequest.d.ts +32 -0
- package/dist/generated/src/models/SamlTicketExchangeRequest.js +50 -0
- package/dist/generated/src/models/ScimGroupResource.d.ts +64 -0
- package/dist/generated/src/models/ScimGroupResource.js +60 -0
- package/dist/generated/src/models/ScimTokenResponse.d.ts +50 -0
- package/dist/generated/src/models/ScimTokenResponse.js +54 -0
- package/dist/generated/src/models/ScimUserResource.d.ts +90 -0
- package/dist/generated/src/models/ScimUserResource.js +70 -0
- package/dist/generated/src/models/SendMessengerMessageRequest.d.ts +2 -2
- package/dist/generated/src/models/SendMessengerMessageRequest.js +4 -4
- package/dist/generated/src/models/ShipmentEventResponse.d.ts +50 -0
- package/dist/generated/src/models/ShipmentEventResponse.js +54 -0
- package/dist/generated/src/models/ShipmentResponse.d.ts +69 -0
- package/dist/generated/src/models/ShipmentResponse.js +61 -0
- package/dist/generated/src/models/ShipmentSummaryResponse.d.ts +68 -0
- package/dist/generated/src/models/ShipmentSummaryResponse.js +60 -0
- package/dist/generated/src/models/SignupRequest.d.ts +13 -1
- package/dist/generated/src/models/SignupRequest.js +14 -3
- package/dist/generated/src/models/SocialRegisterRequest.d.ts +14 -2
- package/dist/generated/src/models/SocialRegisterRequest.js +14 -3
- package/dist/generated/src/models/SortObject.d.ts +2 -2
- package/dist/generated/src/models/SortObject.js +4 -4
- package/dist/generated/src/models/SsoConnectionResponse.d.ts +195 -0
- package/dist/generated/src/models/SsoConnectionResponse.js +103 -0
- package/dist/generated/src/models/StopTrackingResponse.d.ts +50 -0
- package/dist/generated/src/models/StopTrackingResponse.js +54 -0
- package/dist/generated/src/models/StoreConnectionResponse.d.ts +116 -0
- package/dist/generated/src/models/StoreConnectionResponse.js +76 -0
- package/dist/generated/src/models/StoreSyncResponse.d.ts +62 -0
- package/dist/generated/src/models/StoreSyncResponse.js +58 -0
- package/dist/generated/src/models/StoreVendorResponse.d.ts +69 -0
- package/dist/generated/src/models/StoreVendorResponse.js +61 -0
- package/dist/generated/src/models/TallyPartyPayload.d.ts +62 -0
- package/dist/generated/src/models/TallyPartyPayload.js +60 -0
- package/dist/generated/src/models/TallyPushRequest.d.ts +52 -0
- package/dist/generated/src/models/TallyPushRequest.js +56 -0
- package/dist/generated/src/models/TallyPushResponse.d.ts +68 -0
- package/dist/generated/src/models/TallyPushResponse.js +60 -0
- package/dist/generated/src/models/TallyStatusResponse.d.ts +116 -0
- package/dist/generated/src/models/TallyStatusResponse.js +76 -0
- package/dist/generated/src/models/TallyVoucherPayload.d.ts +98 -0
- package/dist/generated/src/models/TallyVoucherPayload.js +76 -0
- package/dist/generated/src/models/TallyVoucherResponse.d.ts +122 -0
- package/dist/generated/src/models/TallyVoucherResponse.js +78 -0
- package/dist/generated/src/models/TrackShipmentRequest.d.ts +60 -0
- package/dist/generated/src/models/TrackShipmentRequest.js +70 -0
- package/dist/generated/src/models/TriggerTypeResponse.d.ts +12 -0
- package/dist/generated/src/models/TriggerTypeResponse.js +4 -0
- package/dist/generated/src/models/UpdateApiKeyChannelAccountsRequest.d.ts +33 -0
- package/dist/generated/src/models/UpdateApiKeyChannelAccountsRequest.js +49 -0
- package/dist/generated/src/models/UpdateApiKeySecurityRequest.d.ts +2 -2
- package/dist/generated/src/models/UpdateApiKeySecurityRequest.js +6 -2
- package/dist/generated/src/models/UpdateCdpSettingsRequest.d.ts +44 -0
- package/dist/generated/src/models/UpdateCdpSettingsRequest.js +52 -0
- package/dist/generated/src/models/UpdateEmailPreferencesRequest.d.ts +1 -1
- package/dist/generated/src/models/UpdateEmailPreferencesRequest.js +3 -1
- package/dist/generated/src/models/UpdateHelpdeskSettingsRequest.d.ts +38 -0
- package/dist/generated/src/models/UpdateHelpdeskSettingsRequest.js +50 -0
- package/dist/generated/src/models/UpdateHubSpotSettingsRequest.d.ts +32 -0
- package/dist/generated/src/models/UpdateHubSpotSettingsRequest.js +48 -0
- package/dist/generated/src/models/UpdateNoCodeImportRequest.d.ts +77 -0
- package/dist/generated/src/models/UpdateNoCodeImportRequest.js +73 -0
- package/dist/generated/src/models/UpdateNotificationPreferenceRequest.d.ts +5 -5
- package/dist/generated/src/models/UpdateNotificationPreferenceRequest.js +15 -5
- package/dist/generated/src/models/UpdateSalesforceSettingsRequest.d.ts +53 -0
- package/dist/generated/src/models/UpdateSalesforceSettingsRequest.js +61 -0
- package/dist/generated/src/models/UpdateSecurityPrefsRequest.d.ts +1 -1
- package/dist/generated/src/models/UpdateSecurityPrefsRequest.js +3 -1
- package/dist/generated/src/models/UpdateWebhookEndpointRequest.d.ts +6 -0
- package/dist/generated/src/models/UpdateWebhookEndpointRequest.js +6 -0
- package/dist/generated/src/models/UpdateWebhookTriggerRequest.d.ts +1 -1
- package/dist/generated/src/models/UpdateZohoBooksSettingsRequest.d.ts +32 -0
- package/dist/generated/src/models/UpdateZohoBooksSettingsRequest.js +50 -0
- package/dist/generated/src/models/UpdateZohoCrmSettingsRequest.d.ts +53 -0
- package/dist/generated/src/models/UpdateZohoCrmSettingsRequest.js +61 -0
- package/dist/generated/src/models/UpsertChatOpsRouteRequest.d.ts +50 -0
- package/dist/generated/src/models/UpsertChatOpsRouteRequest.js +54 -0
- package/dist/generated/src/models/UpsertListMappingRequest.d.ts +44 -0
- package/dist/generated/src/models/UpsertListMappingRequest.js +52 -0
- package/dist/generated/src/models/UpsertNoCodeImportRequest.d.ts +89 -0
- package/dist/generated/src/models/UpsertNoCodeImportRequest.js +85 -0
- package/dist/generated/src/models/UpsertNoCodeResultSinkRequest.d.ts +44 -0
- package/dist/generated/src/models/UpsertNoCodeResultSinkRequest.js +54 -0
- package/dist/generated/src/models/UpsertSsoConnectionRequest.d.ts +134 -0
- package/dist/generated/src/models/UpsertSsoConnectionRequest.js +82 -0
- package/dist/generated/src/models/WabaAccountResponse.d.ts +6 -0
- package/dist/generated/src/models/WabaAccountResponse.js +2 -0
- package/dist/generated/src/models/WebhookDeliveryResponse.d.ts +6 -0
- package/dist/generated/src/models/WebhookDeliveryResponse.js +6 -0
- package/dist/generated/src/models/WebhookEndpointResponse.d.ts +20 -0
- package/dist/generated/src/models/WebhookEndpointResponse.js +16 -1
- package/dist/generated/src/models/WebhookTriggerResponse.d.ts +1 -0
- package/dist/generated/src/models/WebhookTriggerResponse.js +2 -1
- package/dist/generated/src/models/WhatsAppTemplateResponse.d.ts +30 -0
- package/dist/generated/src/models/WhatsAppTemplateResponse.js +10 -0
- package/dist/generated/src/models/ZohoAuthorizeUrlResponse.d.ts +56 -0
- package/dist/generated/src/models/ZohoAuthorizeUrlResponse.js +56 -0
- package/dist/generated/src/models/ZohoBooksInvoiceResponse.d.ts +98 -0
- package/dist/generated/src/models/ZohoBooksInvoiceResponse.js +70 -0
- package/dist/generated/src/models/ZohoBooksOrganizationResponse.d.ts +50 -0
- package/dist/generated/src/models/ZohoBooksOrganizationResponse.js +54 -0
- package/dist/generated/src/models/ZohoBooksRunResponse.d.ts +92 -0
- package/dist/generated/src/models/ZohoBooksRunResponse.js +68 -0
- package/dist/generated/src/models/ZohoBooksStatusResponse.d.ts +134 -0
- package/dist/generated/src/models/ZohoBooksStatusResponse.js +82 -0
- package/dist/generated/src/models/ZohoCrmDealResponse.d.ts +80 -0
- package/dist/generated/src/models/ZohoCrmDealResponse.js +64 -0
- package/dist/generated/src/models/ZohoCrmRunResponse.d.ts +98 -0
- package/dist/generated/src/models/ZohoCrmRunResponse.js +70 -0
- package/dist/generated/src/models/ZohoCrmStatusResponse.d.ts +158 -0
- package/dist/generated/src/models/ZohoCrmStatusResponse.js +90 -0
- package/dist/generated/src/models/index.d.ts +121 -0
- package/dist/generated/src/models/index.js +121 -0
- package/package.json +1 -1
|
@@ -0,0 +1,188 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Augstash Public API
|
|
3
|
+
* Every /api/_** response is wrapped in {success, code, data, message, traceId, timestamp}; the schema shown for an operation is what arrives in `data`, and the SDKs unwrap it. Errors carry a stable `code` - branch on that, never on `message`. Authentication is an ask_live_* key on X-Api-Key, or a bearer token. Operations marked \'Not reachable with an ask_live_* API key\' need a user token.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v1
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import * as runtime from '../runtime';
|
|
13
|
+
import type { ConnectHubSpotRequest, HubSpotRunResponse, HubSpotStatusResponse, PageResponseHubSpotCompanyResponse, PageResponseHubSpotDealResponse, Pageable, UpdateHubSpotSettingsRequest } from '../models/index';
|
|
14
|
+
export interface CompaniesRequest {
|
|
15
|
+
pageable: Pageable;
|
|
16
|
+
}
|
|
17
|
+
export interface ConnectIntegrationsHubspotRequest {
|
|
18
|
+
connectHubSpotRequest: ConnectHubSpotRequest;
|
|
19
|
+
xIdempotencyKey?: string;
|
|
20
|
+
}
|
|
21
|
+
export interface DealsIntegrationsRequest {
|
|
22
|
+
pageable: Pageable;
|
|
23
|
+
}
|
|
24
|
+
export interface SyncNowIntegrationsRequest {
|
|
25
|
+
xIdempotencyKey?: string;
|
|
26
|
+
}
|
|
27
|
+
export interface UpdateSettingsIntegrationsRequest {
|
|
28
|
+
updateHubSpotSettingsRequest: UpdateHubSpotSettingsRequest;
|
|
29
|
+
xIdempotencyKey?: string;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* HubSpotApi - interface
|
|
33
|
+
*
|
|
34
|
+
* @export
|
|
35
|
+
* @interface HubSpotApiInterface
|
|
36
|
+
*/
|
|
37
|
+
export interface HubSpotApiInterface {
|
|
38
|
+
/**
|
|
39
|
+
* A read model: HubSpot owns these records and nothing here creates, edits or deletes one, so every field but the id may be null. crmModifiedAt is how current the data is and lastPulledAt is when we last looked — a sweep that finds nothing changed advances the second and not the first. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
40
|
+
* @summary The companies mirrored from this tenant\'s HubSpot portal
|
|
41
|
+
* @param {Pageable} pageable
|
|
42
|
+
* @param {*} [options] Override http request option.
|
|
43
|
+
* @throws {RequiredError}
|
|
44
|
+
* @memberof HubSpotApiInterface
|
|
45
|
+
*/
|
|
46
|
+
companiesRaw(requestParameters: CompaniesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PageResponseHubSpotCompanyResponse>>;
|
|
47
|
+
/**
|
|
48
|
+
* A read model: HubSpot owns these records and nothing here creates, edits or deletes one, so every field but the id may be null. crmModifiedAt is how current the data is and lastPulledAt is when we last looked — a sweep that finds nothing changed advances the second and not the first. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
49
|
+
* The companies mirrored from this tenant\'s HubSpot portal
|
|
50
|
+
*/
|
|
51
|
+
companies(requestParameters: CompaniesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PageResponseHubSpotCompanyResponse>;
|
|
52
|
+
/**
|
|
53
|
+
* Takes a private app token the customer generates in their own portal, as credentials.accessToken, and it is verified against HubSpot before it is stored. The token must start with pat-: an OAuth access token or a legacy hapikey is refused before any call is made, because those fail live with a 401 that reads as a wrong token rather than as the wrong kind of credential. Credentials are encrypted at rest and are never returned by any endpoint. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
54
|
+
* @summary Connect a HubSpot portal for this tenant
|
|
55
|
+
* @param {ConnectHubSpotRequest} connectHubSpotRequest
|
|
56
|
+
* @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with `X-Idempotent-Replay` set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
|
|
57
|
+
* @param {*} [options] Override http request option.
|
|
58
|
+
* @throws {RequiredError}
|
|
59
|
+
* @memberof HubSpotApiInterface
|
|
60
|
+
*/
|
|
61
|
+
connectIntegrationsHubspotRaw(requestParameters: ConnectIntegrationsHubspotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HubSpotStatusResponse>>;
|
|
62
|
+
/**
|
|
63
|
+
* Takes a private app token the customer generates in their own portal, as credentials.accessToken, and it is verified against HubSpot before it is stored. The token must start with pat-: an OAuth access token or a legacy hapikey is refused before any call is made, because those fail live with a 401 that reads as a wrong token rather than as the wrong kind of credential. Credentials are encrypted at rest and are never returned by any endpoint. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
64
|
+
* Connect a HubSpot portal for this tenant
|
|
65
|
+
*/
|
|
66
|
+
connectIntegrationsHubspot(requestParameters: ConnectIntegrationsHubspotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HubSpotStatusResponse>;
|
|
67
|
+
/**
|
|
68
|
+
* Exists so somebody building an automation can see the stage IDs their own portal uses: a DEAL_STAGE_CHANGED flow triggers on the id, never the label, because a portal\'s owner renames labels freely while ids are stable. stageChangedAt is when we observed the move, not when HubSpot recorded it — HubSpot does not date a stage transition. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
69
|
+
* @summary The deals this tenant\'s syncs have observed, most recently moved first
|
|
70
|
+
* @param {Pageable} pageable
|
|
71
|
+
* @param {*} [options] Override http request option.
|
|
72
|
+
* @throws {RequiredError}
|
|
73
|
+
* @memberof HubSpotApiInterface
|
|
74
|
+
*/
|
|
75
|
+
dealsIntegrationsRaw(requestParameters: DealsIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PageResponseHubSpotDealResponse>>;
|
|
76
|
+
/**
|
|
77
|
+
* Exists so somebody building an automation can see the stage IDs their own portal uses: a DEAL_STAGE_CHANGED flow triggers on the id, never the label, because a portal\'s owner renames labels freely while ids are stable. stageChangedAt is when we observed the move, not when HubSpot recorded it — HubSpot does not date a stage transition. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
78
|
+
* The deals this tenant\'s syncs have observed, most recently moved first
|
|
79
|
+
*/
|
|
80
|
+
dealsIntegrations(requestParameters: DealsIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PageResponseHubSpotDealResponse>;
|
|
81
|
+
/**
|
|
82
|
+
* Health comes from the shared connection substrate, so status here always matches GET /api/v1/integrations/hubspot. The counters are from the last run and are zero before the first one. timelineWatermark is how far conversation history has been mirrored onto CRM records, which is the only field that answers why a recent chat is not on the record yet. Never returns a credential. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
83
|
+
* @summary Whether this tenant has connected HubSpot, and what the last sync did
|
|
84
|
+
* @param {*} [options] Override http request option.
|
|
85
|
+
* @throws {RequiredError}
|
|
86
|
+
* @memberof HubSpotApiInterface
|
|
87
|
+
*/
|
|
88
|
+
statusIntegrationsHubspotRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HubSpotStatusResponse>>;
|
|
89
|
+
/**
|
|
90
|
+
* Health comes from the shared connection substrate, so status here always matches GET /api/v1/integrations/hubspot. The counters are from the last run and are zero before the first one. timelineWatermark is how far conversation history has been mirrored onto CRM records, which is the only field that answers why a recent chat is not on the record yet. Never returns a credential. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
91
|
+
* Whether this tenant has connected HubSpot, and what the last sync did
|
|
92
|
+
*/
|
|
93
|
+
statusIntegrationsHubspot(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HubSpotStatusResponse>;
|
|
94
|
+
/**
|
|
95
|
+
* Four phases in order: companies, contacts, deals, then the conversation timeline. Each is independently fallible, so a rate-limited portal usually yields PARTIAL with phasesCompleted saying how much got through rather than an all-or-nothing failure. Importing a CRM contact records NO consent on any channel — a HubSpot contact list is a sales record, not a permission list. Note that this platform\'s consent model is opt-out, so recording nothing leaves an imported contact reachable exactly as a CSV import does; every one carries the hubspot tag so they can be segmented out. A deal that moved stage raises the DEAL_STAGE_CHANGED automation trigger for every contact on it we hold a link for. Bounded per run, so a large first sync arrives over several runs and each resumes where the last stopped. Runs synchronously and returns what it did, which is why this is a long but bounded budget: < 60s. Requires API-key scope: integrations:write.
|
|
96
|
+
* @summary Run this tenant\'s HubSpot sync now
|
|
97
|
+
* @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with `X-Idempotent-Replay` set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
|
|
98
|
+
* @param {*} [options] Override http request option.
|
|
99
|
+
* @throws {RequiredError}
|
|
100
|
+
* @memberof HubSpotApiInterface
|
|
101
|
+
*/
|
|
102
|
+
syncNowIntegrationsRaw(requestParameters: SyncNowIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HubSpotRunResponse>>;
|
|
103
|
+
/**
|
|
104
|
+
* Four phases in order: companies, contacts, deals, then the conversation timeline. Each is independently fallible, so a rate-limited portal usually yields PARTIAL with phasesCompleted saying how much got through rather than an all-or-nothing failure. Importing a CRM contact records NO consent on any channel — a HubSpot contact list is a sales record, not a permission list. Note that this platform\'s consent model is opt-out, so recording nothing leaves an imported contact reachable exactly as a CSV import does; every one carries the hubspot tag so they can be segmented out. A deal that moved stage raises the DEAL_STAGE_CHANGED automation trigger for every contact on it we hold a link for. Bounded per run, so a large first sync arrives over several runs and each resumes where the last stopped. Runs synchronously and returns what it did, which is why this is a long but bounded budget: < 60s. Requires API-key scope: integrations:write.
|
|
105
|
+
* Run this tenant\'s HubSpot sync now
|
|
106
|
+
*/
|
|
107
|
+
syncNowIntegrations(requestParameters: SyncNowIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HubSpotRunResponse>;
|
|
108
|
+
/**
|
|
109
|
+
* A genuine partial update: send only the fields to change. createMissingContacts defaults FALSE and must be asked for — it creates a HubSpot contact for somebody this business is already in conversation with whom the portal does not have, so their thread has a record to land on. It writes a sales record into the customer\'s own CRM and nothing more: no consent is created or implied by it. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
110
|
+
* @summary Change how this tenant\'s HubSpot integration behaves
|
|
111
|
+
* @param {UpdateHubSpotSettingsRequest} updateHubSpotSettingsRequest
|
|
112
|
+
* @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with `X-Idempotent-Replay` set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
|
|
113
|
+
* @param {*} [options] Override http request option.
|
|
114
|
+
* @throws {RequiredError}
|
|
115
|
+
* @memberof HubSpotApiInterface
|
|
116
|
+
*/
|
|
117
|
+
updateSettingsIntegrationsRaw(requestParameters: UpdateSettingsIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HubSpotStatusResponse>>;
|
|
118
|
+
/**
|
|
119
|
+
* A genuine partial update: send only the fields to change. createMissingContacts defaults FALSE and must be asked for — it creates a HubSpot contact for somebody this business is already in conversation with whom the portal does not have, so their thread has a record to land on. It writes a sales record into the customer\'s own CRM and nothing more: no consent is created or implied by it. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
120
|
+
* Change how this tenant\'s HubSpot integration behaves
|
|
121
|
+
*/
|
|
122
|
+
updateSettingsIntegrations(requestParameters: UpdateSettingsIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HubSpotStatusResponse>;
|
|
123
|
+
}
|
|
124
|
+
/**
|
|
125
|
+
*
|
|
126
|
+
*/
|
|
127
|
+
export declare class HubSpotApi extends runtime.BaseAPI implements HubSpotApiInterface {
|
|
128
|
+
/**
|
|
129
|
+
* A read model: HubSpot owns these records and nothing here creates, edits or deletes one, so every field but the id may be null. crmModifiedAt is how current the data is and lastPulledAt is when we last looked — a sweep that finds nothing changed advances the second and not the first. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
130
|
+
* The companies mirrored from this tenant\'s HubSpot portal
|
|
131
|
+
*/
|
|
132
|
+
companiesRaw(requestParameters: CompaniesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PageResponseHubSpotCompanyResponse>>;
|
|
133
|
+
/**
|
|
134
|
+
* A read model: HubSpot owns these records and nothing here creates, edits or deletes one, so every field but the id may be null. crmModifiedAt is how current the data is and lastPulledAt is when we last looked — a sweep that finds nothing changed advances the second and not the first. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
135
|
+
* The companies mirrored from this tenant\'s HubSpot portal
|
|
136
|
+
*/
|
|
137
|
+
companies(requestParameters: CompaniesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PageResponseHubSpotCompanyResponse>;
|
|
138
|
+
/**
|
|
139
|
+
* Takes a private app token the customer generates in their own portal, as credentials.accessToken, and it is verified against HubSpot before it is stored. The token must start with pat-: an OAuth access token or a legacy hapikey is refused before any call is made, because those fail live with a 401 that reads as a wrong token rather than as the wrong kind of credential. Credentials are encrypted at rest and are never returned by any endpoint. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
140
|
+
* Connect a HubSpot portal for this tenant
|
|
141
|
+
*/
|
|
142
|
+
connectIntegrationsHubspotRaw(requestParameters: ConnectIntegrationsHubspotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HubSpotStatusResponse>>;
|
|
143
|
+
/**
|
|
144
|
+
* Takes a private app token the customer generates in their own portal, as credentials.accessToken, and it is verified against HubSpot before it is stored. The token must start with pat-: an OAuth access token or a legacy hapikey is refused before any call is made, because those fail live with a 401 that reads as a wrong token rather than as the wrong kind of credential. Credentials are encrypted at rest and are never returned by any endpoint. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
145
|
+
* Connect a HubSpot portal for this tenant
|
|
146
|
+
*/
|
|
147
|
+
connectIntegrationsHubspot(requestParameters: ConnectIntegrationsHubspotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HubSpotStatusResponse>;
|
|
148
|
+
/**
|
|
149
|
+
* Exists so somebody building an automation can see the stage IDs their own portal uses: a DEAL_STAGE_CHANGED flow triggers on the id, never the label, because a portal\'s owner renames labels freely while ids are stable. stageChangedAt is when we observed the move, not when HubSpot recorded it — HubSpot does not date a stage transition. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
150
|
+
* The deals this tenant\'s syncs have observed, most recently moved first
|
|
151
|
+
*/
|
|
152
|
+
dealsIntegrationsRaw(requestParameters: DealsIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PageResponseHubSpotDealResponse>>;
|
|
153
|
+
/**
|
|
154
|
+
* Exists so somebody building an automation can see the stage IDs their own portal uses: a DEAL_STAGE_CHANGED flow triggers on the id, never the label, because a portal\'s owner renames labels freely while ids are stable. stageChangedAt is when we observed the move, not when HubSpot recorded it — HubSpot does not date a stage transition. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
155
|
+
* The deals this tenant\'s syncs have observed, most recently moved first
|
|
156
|
+
*/
|
|
157
|
+
dealsIntegrations(requestParameters: DealsIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PageResponseHubSpotDealResponse>;
|
|
158
|
+
/**
|
|
159
|
+
* Health comes from the shared connection substrate, so status here always matches GET /api/v1/integrations/hubspot. The counters are from the last run and are zero before the first one. timelineWatermark is how far conversation history has been mirrored onto CRM records, which is the only field that answers why a recent chat is not on the record yet. Never returns a credential. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
160
|
+
* Whether this tenant has connected HubSpot, and what the last sync did
|
|
161
|
+
*/
|
|
162
|
+
statusIntegrationsHubspotRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HubSpotStatusResponse>>;
|
|
163
|
+
/**
|
|
164
|
+
* Health comes from the shared connection substrate, so status here always matches GET /api/v1/integrations/hubspot. The counters are from the last run and are zero before the first one. timelineWatermark is how far conversation history has been mirrored onto CRM records, which is the only field that answers why a recent chat is not on the record yet. Never returns a credential. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
165
|
+
* Whether this tenant has connected HubSpot, and what the last sync did
|
|
166
|
+
*/
|
|
167
|
+
statusIntegrationsHubspot(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HubSpotStatusResponse>;
|
|
168
|
+
/**
|
|
169
|
+
* Four phases in order: companies, contacts, deals, then the conversation timeline. Each is independently fallible, so a rate-limited portal usually yields PARTIAL with phasesCompleted saying how much got through rather than an all-or-nothing failure. Importing a CRM contact records NO consent on any channel — a HubSpot contact list is a sales record, not a permission list. Note that this platform\'s consent model is opt-out, so recording nothing leaves an imported contact reachable exactly as a CSV import does; every one carries the hubspot tag so they can be segmented out. A deal that moved stage raises the DEAL_STAGE_CHANGED automation trigger for every contact on it we hold a link for. Bounded per run, so a large first sync arrives over several runs and each resumes where the last stopped. Runs synchronously and returns what it did, which is why this is a long but bounded budget: < 60s. Requires API-key scope: integrations:write.
|
|
170
|
+
* Run this tenant\'s HubSpot sync now
|
|
171
|
+
*/
|
|
172
|
+
syncNowIntegrationsRaw(requestParameters: SyncNowIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HubSpotRunResponse>>;
|
|
173
|
+
/**
|
|
174
|
+
* Four phases in order: companies, contacts, deals, then the conversation timeline. Each is independently fallible, so a rate-limited portal usually yields PARTIAL with phasesCompleted saying how much got through rather than an all-or-nothing failure. Importing a CRM contact records NO consent on any channel — a HubSpot contact list is a sales record, not a permission list. Note that this platform\'s consent model is opt-out, so recording nothing leaves an imported contact reachable exactly as a CSV import does; every one carries the hubspot tag so they can be segmented out. A deal that moved stage raises the DEAL_STAGE_CHANGED automation trigger for every contact on it we hold a link for. Bounded per run, so a large first sync arrives over several runs and each resumes where the last stopped. Runs synchronously and returns what it did, which is why this is a long but bounded budget: < 60s. Requires API-key scope: integrations:write.
|
|
175
|
+
* Run this tenant\'s HubSpot sync now
|
|
176
|
+
*/
|
|
177
|
+
syncNowIntegrations(requestParameters?: SyncNowIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HubSpotRunResponse>;
|
|
178
|
+
/**
|
|
179
|
+
* A genuine partial update: send only the fields to change. createMissingContacts defaults FALSE and must be asked for — it creates a HubSpot contact for somebody this business is already in conversation with whom the portal does not have, so their thread has a record to land on. It writes a sales record into the customer\'s own CRM and nothing more: no consent is created or implied by it. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
180
|
+
* Change how this tenant\'s HubSpot integration behaves
|
|
181
|
+
*/
|
|
182
|
+
updateSettingsIntegrationsRaw(requestParameters: UpdateSettingsIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HubSpotStatusResponse>>;
|
|
183
|
+
/**
|
|
184
|
+
* A genuine partial update: send only the fields to change. createMissingContacts defaults FALSE and must be asked for — it creates a HubSpot contact for somebody this business is already in conversation with whom the portal does not have, so their thread has a record to land on. It writes a sales record into the customer\'s own CRM and nothing more: no consent is created or implied by it. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
185
|
+
* Change how this tenant\'s HubSpot integration behaves
|
|
186
|
+
*/
|
|
187
|
+
updateSettingsIntegrations(requestParameters: UpdateSettingsIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HubSpotStatusResponse>;
|
|
188
|
+
}
|
|
@@ -0,0 +1,292 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Augstash Public API
|
|
6
|
+
* Every /api/_** response is wrapped in {success, code, data, message, traceId, timestamp}; the schema shown for an operation is what arrives in `data`, and the SDKs unwrap it. Errors carry a stable `code` - branch on that, never on `message`. Authentication is an ask_live_* key on X-Api-Key, or a bearer token. Operations marked \'Not reachable with an ask_live_* API key\' need a user token.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: v1
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
16
|
+
if (k2 === undefined) k2 = k;
|
|
17
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
18
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
19
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
20
|
+
}
|
|
21
|
+
Object.defineProperty(o, k2, desc);
|
|
22
|
+
}) : (function(o, m, k, k2) {
|
|
23
|
+
if (k2 === undefined) k2 = k;
|
|
24
|
+
o[k2] = m[k];
|
|
25
|
+
}));
|
|
26
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
27
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
28
|
+
}) : function(o, v) {
|
|
29
|
+
o["default"] = v;
|
|
30
|
+
});
|
|
31
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
32
|
+
var ownKeys = function(o) {
|
|
33
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
34
|
+
var ar = [];
|
|
35
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
36
|
+
return ar;
|
|
37
|
+
};
|
|
38
|
+
return ownKeys(o);
|
|
39
|
+
};
|
|
40
|
+
return function (mod) {
|
|
41
|
+
if (mod && mod.__esModule) return mod;
|
|
42
|
+
var result = {};
|
|
43
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
44
|
+
__setModuleDefault(result, mod);
|
|
45
|
+
return result;
|
|
46
|
+
};
|
|
47
|
+
})();
|
|
48
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
49
|
+
exports.HubSpotApi = void 0;
|
|
50
|
+
const runtime = __importStar(require("../runtime"));
|
|
51
|
+
const index_1 = require("../models/index");
|
|
52
|
+
/**
|
|
53
|
+
*
|
|
54
|
+
*/
|
|
55
|
+
class HubSpotApi extends runtime.BaseAPI {
|
|
56
|
+
/**
|
|
57
|
+
* A read model: HubSpot owns these records and nothing here creates, edits or deletes one, so every field but the id may be null. crmModifiedAt is how current the data is and lastPulledAt is when we last looked — a sweep that finds nothing changed advances the second and not the first. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
58
|
+
* The companies mirrored from this tenant\'s HubSpot portal
|
|
59
|
+
*/
|
|
60
|
+
async companiesRaw(requestParameters, initOverrides) {
|
|
61
|
+
if (requestParameters['pageable'] == null) {
|
|
62
|
+
throw new runtime.RequiredError('pageable', 'Required parameter "pageable" was null or undefined when calling companies().');
|
|
63
|
+
}
|
|
64
|
+
const queryParameters = {};
|
|
65
|
+
if (requestParameters['pageable'] != null) {
|
|
66
|
+
queryParameters['pageable'] = requestParameters['pageable'];
|
|
67
|
+
}
|
|
68
|
+
const headerParameters = {};
|
|
69
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
70
|
+
headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
|
|
71
|
+
}
|
|
72
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
73
|
+
const token = this.configuration.accessToken;
|
|
74
|
+
const tokenString = await token("BearerAuth", []);
|
|
75
|
+
if (tokenString) {
|
|
76
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
let urlPath = `/api/v1/integrations/hubspot/companies`;
|
|
80
|
+
const response = await this.request({
|
|
81
|
+
path: urlPath,
|
|
82
|
+
method: 'GET',
|
|
83
|
+
headers: headerParameters,
|
|
84
|
+
query: queryParameters,
|
|
85
|
+
}, initOverrides);
|
|
86
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PageResponseHubSpotCompanyResponseFromJSON)(jsonValue));
|
|
87
|
+
}
|
|
88
|
+
/**
|
|
89
|
+
* A read model: HubSpot owns these records and nothing here creates, edits or deletes one, so every field but the id may be null. crmModifiedAt is how current the data is and lastPulledAt is when we last looked — a sweep that finds nothing changed advances the second and not the first. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
90
|
+
* The companies mirrored from this tenant\'s HubSpot portal
|
|
91
|
+
*/
|
|
92
|
+
async companies(requestParameters, initOverrides) {
|
|
93
|
+
const response = await this.companiesRaw(requestParameters, initOverrides);
|
|
94
|
+
return await response.value();
|
|
95
|
+
}
|
|
96
|
+
/**
|
|
97
|
+
* Takes a private app token the customer generates in their own portal, as credentials.accessToken, and it is verified against HubSpot before it is stored. The token must start with pat-: an OAuth access token or a legacy hapikey is refused before any call is made, because those fail live with a 401 that reads as a wrong token rather than as the wrong kind of credential. Credentials are encrypted at rest and are never returned by any endpoint. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
98
|
+
* Connect a HubSpot portal for this tenant
|
|
99
|
+
*/
|
|
100
|
+
async connectIntegrationsHubspotRaw(requestParameters, initOverrides) {
|
|
101
|
+
if (requestParameters['connectHubSpotRequest'] == null) {
|
|
102
|
+
throw new runtime.RequiredError('connectHubSpotRequest', 'Required parameter "connectHubSpotRequest" was null or undefined when calling connectIntegrationsHubspot().');
|
|
103
|
+
}
|
|
104
|
+
const queryParameters = {};
|
|
105
|
+
const headerParameters = {};
|
|
106
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
107
|
+
if (requestParameters['xIdempotencyKey'] != null) {
|
|
108
|
+
headerParameters['X-Idempotency-Key'] = String(requestParameters['xIdempotencyKey']);
|
|
109
|
+
}
|
|
110
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
111
|
+
headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
|
|
112
|
+
}
|
|
113
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
114
|
+
const token = this.configuration.accessToken;
|
|
115
|
+
const tokenString = await token("BearerAuth", []);
|
|
116
|
+
if (tokenString) {
|
|
117
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
let urlPath = `/api/v1/integrations/hubspot`;
|
|
121
|
+
const response = await this.request({
|
|
122
|
+
path: urlPath,
|
|
123
|
+
method: 'POST',
|
|
124
|
+
headers: headerParameters,
|
|
125
|
+
query: queryParameters,
|
|
126
|
+
body: (0, index_1.ConnectHubSpotRequestToJSON)(requestParameters['connectHubSpotRequest']),
|
|
127
|
+
}, initOverrides);
|
|
128
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.HubSpotStatusResponseFromJSON)(jsonValue));
|
|
129
|
+
}
|
|
130
|
+
/**
|
|
131
|
+
* Takes a private app token the customer generates in their own portal, as credentials.accessToken, and it is verified against HubSpot before it is stored. The token must start with pat-: an OAuth access token or a legacy hapikey is refused before any call is made, because those fail live with a 401 that reads as a wrong token rather than as the wrong kind of credential. Credentials are encrypted at rest and are never returned by any endpoint. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
132
|
+
* Connect a HubSpot portal for this tenant
|
|
133
|
+
*/
|
|
134
|
+
async connectIntegrationsHubspot(requestParameters, initOverrides) {
|
|
135
|
+
const response = await this.connectIntegrationsHubspotRaw(requestParameters, initOverrides);
|
|
136
|
+
return await response.value();
|
|
137
|
+
}
|
|
138
|
+
/**
|
|
139
|
+
* Exists so somebody building an automation can see the stage IDs their own portal uses: a DEAL_STAGE_CHANGED flow triggers on the id, never the label, because a portal\'s owner renames labels freely while ids are stable. stageChangedAt is when we observed the move, not when HubSpot recorded it — HubSpot does not date a stage transition. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
140
|
+
* The deals this tenant\'s syncs have observed, most recently moved first
|
|
141
|
+
*/
|
|
142
|
+
async dealsIntegrationsRaw(requestParameters, initOverrides) {
|
|
143
|
+
if (requestParameters['pageable'] == null) {
|
|
144
|
+
throw new runtime.RequiredError('pageable', 'Required parameter "pageable" was null or undefined when calling dealsIntegrations().');
|
|
145
|
+
}
|
|
146
|
+
const queryParameters = {};
|
|
147
|
+
if (requestParameters['pageable'] != null) {
|
|
148
|
+
queryParameters['pageable'] = requestParameters['pageable'];
|
|
149
|
+
}
|
|
150
|
+
const headerParameters = {};
|
|
151
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
152
|
+
headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
|
|
153
|
+
}
|
|
154
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
155
|
+
const token = this.configuration.accessToken;
|
|
156
|
+
const tokenString = await token("BearerAuth", []);
|
|
157
|
+
if (tokenString) {
|
|
158
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
159
|
+
}
|
|
160
|
+
}
|
|
161
|
+
let urlPath = `/api/v1/integrations/hubspot/deals`;
|
|
162
|
+
const response = await this.request({
|
|
163
|
+
path: urlPath,
|
|
164
|
+
method: 'GET',
|
|
165
|
+
headers: headerParameters,
|
|
166
|
+
query: queryParameters,
|
|
167
|
+
}, initOverrides);
|
|
168
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PageResponseHubSpotDealResponseFromJSON)(jsonValue));
|
|
169
|
+
}
|
|
170
|
+
/**
|
|
171
|
+
* Exists so somebody building an automation can see the stage IDs their own portal uses: a DEAL_STAGE_CHANGED flow triggers on the id, never the label, because a portal\'s owner renames labels freely while ids are stable. stageChangedAt is when we observed the move, not when HubSpot recorded it — HubSpot does not date a stage transition. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
172
|
+
* The deals this tenant\'s syncs have observed, most recently moved first
|
|
173
|
+
*/
|
|
174
|
+
async dealsIntegrations(requestParameters, initOverrides) {
|
|
175
|
+
const response = await this.dealsIntegrationsRaw(requestParameters, initOverrides);
|
|
176
|
+
return await response.value();
|
|
177
|
+
}
|
|
178
|
+
/**
|
|
179
|
+
* Health comes from the shared connection substrate, so status here always matches GET /api/v1/integrations/hubspot. The counters are from the last run and are zero before the first one. timelineWatermark is how far conversation history has been mirrored onto CRM records, which is the only field that answers why a recent chat is not on the record yet. Never returns a credential. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
180
|
+
* Whether this tenant has connected HubSpot, and what the last sync did
|
|
181
|
+
*/
|
|
182
|
+
async statusIntegrationsHubspotRaw(initOverrides) {
|
|
183
|
+
const queryParameters = {};
|
|
184
|
+
const headerParameters = {};
|
|
185
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
186
|
+
headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
|
|
187
|
+
}
|
|
188
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
189
|
+
const token = this.configuration.accessToken;
|
|
190
|
+
const tokenString = await token("BearerAuth", []);
|
|
191
|
+
if (tokenString) {
|
|
192
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
193
|
+
}
|
|
194
|
+
}
|
|
195
|
+
let urlPath = `/api/v1/integrations/hubspot`;
|
|
196
|
+
const response = await this.request({
|
|
197
|
+
path: urlPath,
|
|
198
|
+
method: 'GET',
|
|
199
|
+
headers: headerParameters,
|
|
200
|
+
query: queryParameters,
|
|
201
|
+
}, initOverrides);
|
|
202
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.HubSpotStatusResponseFromJSON)(jsonValue));
|
|
203
|
+
}
|
|
204
|
+
/**
|
|
205
|
+
* Health comes from the shared connection substrate, so status here always matches GET /api/v1/integrations/hubspot. The counters are from the last run and are zero before the first one. timelineWatermark is how far conversation history has been mirrored onto CRM records, which is the only field that answers why a recent chat is not on the record yet. Never returns a credential. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
206
|
+
* Whether this tenant has connected HubSpot, and what the last sync did
|
|
207
|
+
*/
|
|
208
|
+
async statusIntegrationsHubspot(initOverrides) {
|
|
209
|
+
const response = await this.statusIntegrationsHubspotRaw(initOverrides);
|
|
210
|
+
return await response.value();
|
|
211
|
+
}
|
|
212
|
+
/**
|
|
213
|
+
* Four phases in order: companies, contacts, deals, then the conversation timeline. Each is independently fallible, so a rate-limited portal usually yields PARTIAL with phasesCompleted saying how much got through rather than an all-or-nothing failure. Importing a CRM contact records NO consent on any channel — a HubSpot contact list is a sales record, not a permission list. Note that this platform\'s consent model is opt-out, so recording nothing leaves an imported contact reachable exactly as a CSV import does; every one carries the hubspot tag so they can be segmented out. A deal that moved stage raises the DEAL_STAGE_CHANGED automation trigger for every contact on it we hold a link for. Bounded per run, so a large first sync arrives over several runs and each resumes where the last stopped. Runs synchronously and returns what it did, which is why this is a long but bounded budget: < 60s. Requires API-key scope: integrations:write.
|
|
214
|
+
* Run this tenant\'s HubSpot sync now
|
|
215
|
+
*/
|
|
216
|
+
async syncNowIntegrationsRaw(requestParameters, initOverrides) {
|
|
217
|
+
const queryParameters = {};
|
|
218
|
+
const headerParameters = {};
|
|
219
|
+
if (requestParameters['xIdempotencyKey'] != null) {
|
|
220
|
+
headerParameters['X-Idempotency-Key'] = String(requestParameters['xIdempotencyKey']);
|
|
221
|
+
}
|
|
222
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
223
|
+
headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
|
|
224
|
+
}
|
|
225
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
226
|
+
const token = this.configuration.accessToken;
|
|
227
|
+
const tokenString = await token("BearerAuth", []);
|
|
228
|
+
if (tokenString) {
|
|
229
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
230
|
+
}
|
|
231
|
+
}
|
|
232
|
+
let urlPath = `/api/v1/integrations/hubspot/sync`;
|
|
233
|
+
const response = await this.request({
|
|
234
|
+
path: urlPath,
|
|
235
|
+
method: 'POST',
|
|
236
|
+
headers: headerParameters,
|
|
237
|
+
query: queryParameters,
|
|
238
|
+
}, initOverrides);
|
|
239
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.HubSpotRunResponseFromJSON)(jsonValue));
|
|
240
|
+
}
|
|
241
|
+
/**
|
|
242
|
+
* Four phases in order: companies, contacts, deals, then the conversation timeline. Each is independently fallible, so a rate-limited portal usually yields PARTIAL with phasesCompleted saying how much got through rather than an all-or-nothing failure. Importing a CRM contact records NO consent on any channel — a HubSpot contact list is a sales record, not a permission list. Note that this platform\'s consent model is opt-out, so recording nothing leaves an imported contact reachable exactly as a CSV import does; every one carries the hubspot tag so they can be segmented out. A deal that moved stage raises the DEAL_STAGE_CHANGED automation trigger for every contact on it we hold a link for. Bounded per run, so a large first sync arrives over several runs and each resumes where the last stopped. Runs synchronously and returns what it did, which is why this is a long but bounded budget: < 60s. Requires API-key scope: integrations:write.
|
|
243
|
+
* Run this tenant\'s HubSpot sync now
|
|
244
|
+
*/
|
|
245
|
+
async syncNowIntegrations(requestParameters = {}, initOverrides) {
|
|
246
|
+
const response = await this.syncNowIntegrationsRaw(requestParameters, initOverrides);
|
|
247
|
+
return await response.value();
|
|
248
|
+
}
|
|
249
|
+
/**
|
|
250
|
+
* A genuine partial update: send only the fields to change. createMissingContacts defaults FALSE and must be asked for — it creates a HubSpot contact for somebody this business is already in conversation with whom the portal does not have, so their thread has a record to land on. It writes a sales record into the customer\'s own CRM and nothing more: no consent is created or implied by it. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
251
|
+
* Change how this tenant\'s HubSpot integration behaves
|
|
252
|
+
*/
|
|
253
|
+
async updateSettingsIntegrationsRaw(requestParameters, initOverrides) {
|
|
254
|
+
if (requestParameters['updateHubSpotSettingsRequest'] == null) {
|
|
255
|
+
throw new runtime.RequiredError('updateHubSpotSettingsRequest', 'Required parameter "updateHubSpotSettingsRequest" was null or undefined when calling updateSettingsIntegrations().');
|
|
256
|
+
}
|
|
257
|
+
const queryParameters = {};
|
|
258
|
+
const headerParameters = {};
|
|
259
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
260
|
+
if (requestParameters['xIdempotencyKey'] != null) {
|
|
261
|
+
headerParameters['X-Idempotency-Key'] = String(requestParameters['xIdempotencyKey']);
|
|
262
|
+
}
|
|
263
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
264
|
+
headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
|
|
265
|
+
}
|
|
266
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
267
|
+
const token = this.configuration.accessToken;
|
|
268
|
+
const tokenString = await token("BearerAuth", []);
|
|
269
|
+
if (tokenString) {
|
|
270
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
271
|
+
}
|
|
272
|
+
}
|
|
273
|
+
let urlPath = `/api/v1/integrations/hubspot/settings`;
|
|
274
|
+
const response = await this.request({
|
|
275
|
+
path: urlPath,
|
|
276
|
+
method: 'PATCH',
|
|
277
|
+
headers: headerParameters,
|
|
278
|
+
query: queryParameters,
|
|
279
|
+
body: (0, index_1.UpdateHubSpotSettingsRequestToJSON)(requestParameters['updateHubSpotSettingsRequest']),
|
|
280
|
+
}, initOverrides);
|
|
281
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.HubSpotStatusResponseFromJSON)(jsonValue));
|
|
282
|
+
}
|
|
283
|
+
/**
|
|
284
|
+
* A genuine partial update: send only the fields to change. createMissingContacts defaults FALSE and must be asked for — it creates a HubSpot contact for somebody this business is already in conversation with whom the portal does not have, so their thread has a record to land on. It writes a sales record into the customer\'s own CRM and nothing more: no consent is created or implied by it. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
285
|
+
* Change how this tenant\'s HubSpot integration behaves
|
|
286
|
+
*/
|
|
287
|
+
async updateSettingsIntegrations(requestParameters, initOverrides) {
|
|
288
|
+
const response = await this.updateSettingsIntegrationsRaw(requestParameters, initOverrides);
|
|
289
|
+
return await response.value();
|
|
290
|
+
}
|
|
291
|
+
}
|
|
292
|
+
exports.HubSpotApi = HubSpotApi;
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Augstash Public API
|
|
3
|
+
* Every /api/_** response is wrapped in {success, code, data, message, traceId, timestamp}; the schema shown for an operation is what arrives in `data`, and the SDKs unwrap it. Errors carry a stable `code` - branch on that, never on `message`. Authentication is an ask_live_* key on X-Api-Key, or a bearer token. Operations marked \'Not reachable with an ask_live_* API key\' need a user token.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v1
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import * as runtime from '../runtime';
|
|
13
|
+
import type { IntegrationConnectionResponse } from '../models/index';
|
|
14
|
+
export interface DisconnectIntegrationsRequest {
|
|
15
|
+
vendor: string;
|
|
16
|
+
xIdempotencyKey?: string;
|
|
17
|
+
}
|
|
18
|
+
export interface GetIntegrationsRequest {
|
|
19
|
+
vendor: string;
|
|
20
|
+
}
|
|
21
|
+
export interface HealthIntegrationsRequest {
|
|
22
|
+
vendor: string;
|
|
23
|
+
xIdempotencyKey?: string;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* IntegrationConnectionApi - interface
|
|
27
|
+
*
|
|
28
|
+
* @export
|
|
29
|
+
* @interface IntegrationConnectionApiInterface
|
|
30
|
+
*/
|
|
31
|
+
export interface IntegrationConnectionApiInterface {
|
|
32
|
+
/**
|
|
33
|
+
* Idempotent: 204 whether or not a connection existed. Revokes the grant upstream where the vendor supports it, and clears whatever the connector stored of its own. Data already imported is kept — it is the customer\'s history, not the connector\'s. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
34
|
+
* @summary Disconnect the tenant from one vendor
|
|
35
|
+
* @param {string} vendor
|
|
36
|
+
* @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with `X-Idempotent-Replay` set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
|
|
37
|
+
* @param {*} [options] Override http request option.
|
|
38
|
+
* @throws {RequiredError}
|
|
39
|
+
* @memberof IntegrationConnectionApiInterface
|
|
40
|
+
*/
|
|
41
|
+
disconnectIntegrationsRaw(requestParameters: DisconnectIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
42
|
+
/**
|
|
43
|
+
* Idempotent: 204 whether or not a connection existed. Revokes the grant upstream where the vendor supports it, and clears whatever the connector stored of its own. Data already imported is kept — it is the customer\'s history, not the connector\'s. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
44
|
+
* Disconnect the tenant from one vendor
|
|
45
|
+
*/
|
|
46
|
+
disconnectIntegrations(requestParameters: DisconnectIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
47
|
+
/**
|
|
48
|
+
* Never returns a credential value — credentialKeys carries the stored credential\'s field NAMES only. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
49
|
+
* @summary Get the tenant\'s connection to one vendor
|
|
50
|
+
* @param {string} vendor
|
|
51
|
+
* @param {*} [options] Override http request option.
|
|
52
|
+
* @throws {RequiredError}
|
|
53
|
+
* @memberof IntegrationConnectionApiInterface
|
|
54
|
+
*/
|
|
55
|
+
getIntegrationsRaw(requestParameters: GetIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IntegrationConnectionResponse>>;
|
|
56
|
+
/**
|
|
57
|
+
* Never returns a credential value — credentialKeys carries the stored credential\'s field NAMES only. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
58
|
+
* Get the tenant\'s connection to one vendor
|
|
59
|
+
*/
|
|
60
|
+
getIntegrations(requestParameters: GetIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IntegrationConnectionResponse>;
|
|
61
|
+
/**
|
|
62
|
+
* Asks the vendor now and records the verdict. A vendor that refuses or does not answer is reported as status DEGRADED (or REVOKED, when the credential itself is finished) with a lastErrorCode — not as an error response. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
63
|
+
* @summary Re-check the tenant\'s connection to one vendor
|
|
64
|
+
* @param {string} vendor
|
|
65
|
+
* @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with `X-Idempotent-Replay` set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
|
|
66
|
+
* @param {*} [options] Override http request option.
|
|
67
|
+
* @throws {RequiredError}
|
|
68
|
+
* @memberof IntegrationConnectionApiInterface
|
|
69
|
+
*/
|
|
70
|
+
healthIntegrationsRaw(requestParameters: HealthIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IntegrationConnectionResponse>>;
|
|
71
|
+
/**
|
|
72
|
+
* Asks the vendor now and records the verdict. A vendor that refuses or does not answer is reported as status DEGRADED (or REVOKED, when the credential itself is finished) with a lastErrorCode — not as an error response. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
73
|
+
* Re-check the tenant\'s connection to one vendor
|
|
74
|
+
*/
|
|
75
|
+
healthIntegrations(requestParameters: HealthIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IntegrationConnectionResponse>;
|
|
76
|
+
}
|
|
77
|
+
/**
|
|
78
|
+
*
|
|
79
|
+
*/
|
|
80
|
+
export declare class IntegrationConnectionApi extends runtime.BaseAPI implements IntegrationConnectionApiInterface {
|
|
81
|
+
/**
|
|
82
|
+
* Idempotent: 204 whether or not a connection existed. Revokes the grant upstream where the vendor supports it, and clears whatever the connector stored of its own. Data already imported is kept — it is the customer\'s history, not the connector\'s. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
83
|
+
* Disconnect the tenant from one vendor
|
|
84
|
+
*/
|
|
85
|
+
disconnectIntegrationsRaw(requestParameters: DisconnectIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
86
|
+
/**
|
|
87
|
+
* Idempotent: 204 whether or not a connection existed. Revokes the grant upstream where the vendor supports it, and clears whatever the connector stored of its own. Data already imported is kept — it is the customer\'s history, not the connector\'s. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
88
|
+
* Disconnect the tenant from one vendor
|
|
89
|
+
*/
|
|
90
|
+
disconnectIntegrations(requestParameters: DisconnectIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
91
|
+
/**
|
|
92
|
+
* Never returns a credential value — credentialKeys carries the stored credential\'s field NAMES only. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
93
|
+
* Get the tenant\'s connection to one vendor
|
|
94
|
+
*/
|
|
95
|
+
getIntegrationsRaw(requestParameters: GetIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IntegrationConnectionResponse>>;
|
|
96
|
+
/**
|
|
97
|
+
* Never returns a credential value — credentialKeys carries the stored credential\'s field NAMES only. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
98
|
+
* Get the tenant\'s connection to one vendor
|
|
99
|
+
*/
|
|
100
|
+
getIntegrations(requestParameters: GetIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IntegrationConnectionResponse>;
|
|
101
|
+
/**
|
|
102
|
+
* Asks the vendor now and records the verdict. A vendor that refuses or does not answer is reported as status DEGRADED (or REVOKED, when the credential itself is finished) with a lastErrorCode — not as an error response. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
103
|
+
* Re-check the tenant\'s connection to one vendor
|
|
104
|
+
*/
|
|
105
|
+
healthIntegrationsRaw(requestParameters: HealthIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IntegrationConnectionResponse>>;
|
|
106
|
+
/**
|
|
107
|
+
* Asks the vendor now and records the verdict. A vendor that refuses or does not answer is reported as status DEGRADED (or REVOKED, when the credential itself is finished) with a lastErrorCode — not as an error response. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
108
|
+
* Re-check the tenant\'s connection to one vendor
|
|
109
|
+
*/
|
|
110
|
+
healthIntegrations(requestParameters: HealthIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IntegrationConnectionResponse>;
|
|
111
|
+
}
|