@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,186 @@
|
|
|
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 { PageResponseSalesforceAccountResponse, PageResponseSalesforceOpportunityResponse, Pageable, SalesforceAuthorizeUrlResponse, SalesforceRunResponse, SalesforceStatusResponse, UpdateSalesforceSettingsRequest } from '../models/index';
|
|
14
|
+
export interface AccountsRequest {
|
|
15
|
+
pageable: Pageable;
|
|
16
|
+
}
|
|
17
|
+
export interface AuthorizeUrlIntegrationsSalesforceRequest {
|
|
18
|
+
environment?: string;
|
|
19
|
+
}
|
|
20
|
+
export interface OpportunitiesRequest {
|
|
21
|
+
pageable: Pageable;
|
|
22
|
+
}
|
|
23
|
+
export interface SyncNowIntegrationsSalesforceRequest {
|
|
24
|
+
xIdempotencyKey?: string;
|
|
25
|
+
}
|
|
26
|
+
export interface UpdateSettingsIntegrationsSalesforceRequest {
|
|
27
|
+
updateSalesforceSettingsRequest: UpdateSalesforceSettingsRequest;
|
|
28
|
+
xIdempotencyKey?: string;
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* SalesforceApi - interface
|
|
32
|
+
*
|
|
33
|
+
* @export
|
|
34
|
+
* @interface SalesforceApiInterface
|
|
35
|
+
*/
|
|
36
|
+
export interface SalesforceApiInterface {
|
|
37
|
+
/**
|
|
38
|
+
* A read model (NI-10b): Salesforce 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. A Contact link carries its crmAccountId, so \"everyone at Acme\" is a join on this list. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
39
|
+
* @summary The Accounts mirrored from this tenant\'s Salesforce org
|
|
40
|
+
* @param {Pageable} pageable
|
|
41
|
+
* @param {*} [options] Override http request option.
|
|
42
|
+
* @throws {RequiredError}
|
|
43
|
+
* @memberof SalesforceApiInterface
|
|
44
|
+
*/
|
|
45
|
+
accountsRaw(requestParameters: AccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PageResponseSalesforceAccountResponse>>;
|
|
46
|
+
/**
|
|
47
|
+
* A read model (NI-10b): Salesforce 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. A Contact link carries its crmAccountId, so \"everyone at Acme\" is a join on this list. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
48
|
+
* The Accounts mirrored from this tenant\'s Salesforce org
|
|
49
|
+
*/
|
|
50
|
+
accounts(requestParameters: AccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PageResponseSalesforceAccountResponse>;
|
|
51
|
+
/**
|
|
52
|
+
* Returns the absolute Salesforce OAuth URL to navigate the browser to, carrying a signed state token that binds this tenant for the unauthenticated callback. environment selects the login host: production (the default) uses login.salesforce.com, sandbox uses test.salesforce.com. ⚠️ Choosing the wrong one fails at consent as invalid_grant, which reads as a wrong password — so offer the user the choice explicitly rather than defaulting silently. scopes is the exact list the consent screen will show, space-separated in the order Salesforce receives it; render it so an admin knows what is being asked before they are standing on the screen. The state field is for diagnostics only — it is already embedded in authorizeUrl and must not be parsed, stored or resent by a client. Makes no Salesforce call. Writes < 300ms. Requires API-key scope: integrations:write.
|
|
53
|
+
* @summary Build the Salesforce consent URL that starts a connect
|
|
54
|
+
* @param {string} [environment]
|
|
55
|
+
* @param {*} [options] Override http request option.
|
|
56
|
+
* @throws {RequiredError}
|
|
57
|
+
* @memberof SalesforceApiInterface
|
|
58
|
+
*/
|
|
59
|
+
authorizeUrlIntegrationsSalesforceRaw(requestParameters: AuthorizeUrlIntegrationsSalesforceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SalesforceAuthorizeUrlResponse>>;
|
|
60
|
+
/**
|
|
61
|
+
* Returns the absolute Salesforce OAuth URL to navigate the browser to, carrying a signed state token that binds this tenant for the unauthenticated callback. environment selects the login host: production (the default) uses login.salesforce.com, sandbox uses test.salesforce.com. ⚠️ Choosing the wrong one fails at consent as invalid_grant, which reads as a wrong password — so offer the user the choice explicitly rather than defaulting silently. scopes is the exact list the consent screen will show, space-separated in the order Salesforce receives it; render it so an admin knows what is being asked before they are standing on the screen. The state field is for diagnostics only — it is already embedded in authorizeUrl and must not be parsed, stored or resent by a client. Makes no Salesforce call. Writes < 300ms. Requires API-key scope: integrations:write.
|
|
62
|
+
* Build the Salesforce consent URL that starts a connect
|
|
63
|
+
*/
|
|
64
|
+
authorizeUrlIntegrationsSalesforce(requestParameters: AuthorizeUrlIntegrationsSalesforceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SalesforceAuthorizeUrlResponse>;
|
|
65
|
+
/**
|
|
66
|
+
* Exists (NI-10b) so somebody building an automation can see the stage values their own org uses: a DEAL_STAGE_CHANGED flow triggers on stage, which is StageName\'s API value — Salesforce has no separate stage id, and the label is what an admin renames. closed and won are Salesforce\'s own IsClosed/IsWon, the answer to \"is this Closed Won\" however the org spells the stage. stageChangedAt is when we observed the move, not when Salesforce recorded it. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
67
|
+
* @summary The Opportunities this tenant\'s syncs have observed, most recently moved first
|
|
68
|
+
* @param {Pageable} pageable
|
|
69
|
+
* @param {*} [options] Override http request option.
|
|
70
|
+
* @throws {RequiredError}
|
|
71
|
+
* @memberof SalesforceApiInterface
|
|
72
|
+
*/
|
|
73
|
+
opportunitiesRaw(requestParameters: OpportunitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PageResponseSalesforceOpportunityResponse>>;
|
|
74
|
+
/**
|
|
75
|
+
* Exists (NI-10b) so somebody building an automation can see the stage values their own org uses: a DEAL_STAGE_CHANGED flow triggers on stage, which is StageName\'s API value — Salesforce has no separate stage id, and the label is what an admin renames. closed and won are Salesforce\'s own IsClosed/IsWon, the answer to \"is this Closed Won\" however the org spells the stage. stageChangedAt is when we observed the move, not when Salesforce recorded it. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
76
|
+
* The Opportunities this tenant\'s syncs have observed, most recently moved first
|
|
77
|
+
*/
|
|
78
|
+
opportunities(requestParameters: OpportunitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PageResponseSalesforceOpportunityResponse>;
|
|
79
|
+
/**
|
|
80
|
+
* Health comes from the shared connection substrate, so status here always matches GET /api/v1/integrations/salesforce. The counters are from the last run and are zero before the first one. activityWatermark is how far conversation history has been written onto CRM records, which is the only field that answers why a recent chat is not on the record yet. instanceUrl and environment are returned so an operator can confirm the integration points at the org they meant — connecting a sandbox by mistake is this integration\'s most likely misconfiguration. Never returns a token. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
81
|
+
* @summary Whether this tenant has connected Salesforce, and what the last sync did
|
|
82
|
+
* @param {*} [options] Override http request option.
|
|
83
|
+
* @throws {RequiredError}
|
|
84
|
+
* @memberof SalesforceApiInterface
|
|
85
|
+
*/
|
|
86
|
+
statusIntegrationsSalesforceRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SalesforceStatusResponse>>;
|
|
87
|
+
/**
|
|
88
|
+
* Health comes from the shared connection substrate, so status here always matches GET /api/v1/integrations/salesforce. The counters are from the last run and are zero before the first one. activityWatermark is how far conversation history has been written onto CRM records, which is the only field that answers why a recent chat is not on the record yet. instanceUrl and environment are returned so an operator can confirm the integration points at the org they meant — connecting a sandbox by mistake is this integration\'s most likely misconfiguration. Never returns a token. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
89
|
+
* Whether this tenant has connected Salesforce, and what the last sync did
|
|
90
|
+
*/
|
|
91
|
+
statusIntegrationsSalesforce(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SalesforceStatusResponse>;
|
|
92
|
+
/**
|
|
93
|
+
* Five phases in order: Accounts, Contacts, Leads (when syncLeads is on), Opportunities (when syncOpportunities is on — each stage CHANGE is announced to automations as a CRM deal-stage event with vendor salesforce; stageChanges counts them, and against opportunitiesPulled it is the difference between modified and moved), then the conversation activity write-back — which, when pushPeopleAs is set, first CREATES the record for anybody the org lacks and counts it in peoplePushed. Contacts run before Leads because a person who is both — which a converted Lead makes routine — has their conversations filed against the Contact. Each phase is independently fallible, so an org that has spent its daily API allowance usually yields PARTIAL with phasesCompleted saying how much got through rather than an all-or-nothing failure. ⚠️ A Salesforce rate limit is a DAILY org budget shared with every other tool the customer has connected, so PARTIAL can persist for hours and does NOT mean the grant is broken — do not prompt a reconnect for it. Importing a Contact or Lead records NO consent on any channel; a CRM record is a sales record, not a permission list. Note that this platform\'s consent model is opt-out, so recording nothing leaves an imported person reachable exactly as a CSV import does; every one carries the salesforce tag so they can be segmented out. tokenRefreshes above 1 means the org\'s session timeout is shorter than a sync takes. 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.
|
|
94
|
+
* @summary Run this tenant\'s Salesforce sync now
|
|
95
|
+
* @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.
|
|
96
|
+
* @param {*} [options] Override http request option.
|
|
97
|
+
* @throws {RequiredError}
|
|
98
|
+
* @memberof SalesforceApiInterface
|
|
99
|
+
*/
|
|
100
|
+
syncNowIntegrationsSalesforceRaw(requestParameters: SyncNowIntegrationsSalesforceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SalesforceRunResponse>>;
|
|
101
|
+
/**
|
|
102
|
+
* Five phases in order: Accounts, Contacts, Leads (when syncLeads is on), Opportunities (when syncOpportunities is on — each stage CHANGE is announced to automations as a CRM deal-stage event with vendor salesforce; stageChanges counts them, and against opportunitiesPulled it is the difference between modified and moved), then the conversation activity write-back — which, when pushPeopleAs is set, first CREATES the record for anybody the org lacks and counts it in peoplePushed. Contacts run before Leads because a person who is both — which a converted Lead makes routine — has their conversations filed against the Contact. Each phase is independently fallible, so an org that has spent its daily API allowance usually yields PARTIAL with phasesCompleted saying how much got through rather than an all-or-nothing failure. ⚠️ A Salesforce rate limit is a DAILY org budget shared with every other tool the customer has connected, so PARTIAL can persist for hours and does NOT mean the grant is broken — do not prompt a reconnect for it. Importing a Contact or Lead records NO consent on any channel; a CRM record is a sales record, not a permission list. Note that this platform\'s consent model is opt-out, so recording nothing leaves an imported person reachable exactly as a CSV import does; every one carries the salesforce tag so they can be segmented out. tokenRefreshes above 1 means the org\'s session timeout is shorter than a sync takes. 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.
|
|
103
|
+
* Run this tenant\'s Salesforce sync now
|
|
104
|
+
*/
|
|
105
|
+
syncNowIntegrationsSalesforce(requestParameters: SyncNowIntegrationsSalesforceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SalesforceRunResponse>;
|
|
106
|
+
/**
|
|
107
|
+
* A genuine partial update: send only the fields to change. syncLeads defaults TRUE, unlike NI-6\'s setting, because this one only reads — and Leads are usually the larger and more interesting half of an org for a messaging product. Turn it off for an org whose Lead table is a purchased list the sales team ignores. syncOpportunities (NI-10b) defaults TRUE and also only reads — but it ANNOUNCES: a CRM deal-stage automation whose trigger was never narrowed on vendor fires for ANY CRM, so a flow built for HubSpot and left unnarrowed starts being enrolled by Salesforce Opportunities the sweep after this is on. Turn it off here or narrow the flow. pushPeopleAs (NI-10b) is none|lead|contact and defaults none: the other two WRITE people into the customer\'s org, and Salesforce forces a choice HubSpot never did — a Lead needs no Account and may be treated as spam by the sales team; a Contact is the record they work from and arrives with no Account. Only people a conversation already exists with, only ones with an email, bounded per run. Importing a Contact or a Lead — or creating one — records NO consent on any channel. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
108
|
+
* @summary Change how this tenant\'s Salesforce integration behaves
|
|
109
|
+
* @param {UpdateSalesforceSettingsRequest} updateSalesforceSettingsRequest
|
|
110
|
+
* @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.
|
|
111
|
+
* @param {*} [options] Override http request option.
|
|
112
|
+
* @throws {RequiredError}
|
|
113
|
+
* @memberof SalesforceApiInterface
|
|
114
|
+
*/
|
|
115
|
+
updateSettingsIntegrationsSalesforceRaw(requestParameters: UpdateSettingsIntegrationsSalesforceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SalesforceStatusResponse>>;
|
|
116
|
+
/**
|
|
117
|
+
* A genuine partial update: send only the fields to change. syncLeads defaults TRUE, unlike NI-6\'s setting, because this one only reads — and Leads are usually the larger and more interesting half of an org for a messaging product. Turn it off for an org whose Lead table is a purchased list the sales team ignores. syncOpportunities (NI-10b) defaults TRUE and also only reads — but it ANNOUNCES: a CRM deal-stage automation whose trigger was never narrowed on vendor fires for ANY CRM, so a flow built for HubSpot and left unnarrowed starts being enrolled by Salesforce Opportunities the sweep after this is on. Turn it off here or narrow the flow. pushPeopleAs (NI-10b) is none|lead|contact and defaults none: the other two WRITE people into the customer\'s org, and Salesforce forces a choice HubSpot never did — a Lead needs no Account and may be treated as spam by the sales team; a Contact is the record they work from and arrives with no Account. Only people a conversation already exists with, only ones with an email, bounded per run. Importing a Contact or a Lead — or creating one — records NO consent on any channel. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
118
|
+
* Change how this tenant\'s Salesforce integration behaves
|
|
119
|
+
*/
|
|
120
|
+
updateSettingsIntegrationsSalesforce(requestParameters: UpdateSettingsIntegrationsSalesforceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SalesforceStatusResponse>;
|
|
121
|
+
}
|
|
122
|
+
/**
|
|
123
|
+
*
|
|
124
|
+
*/
|
|
125
|
+
export declare class SalesforceApi extends runtime.BaseAPI implements SalesforceApiInterface {
|
|
126
|
+
/**
|
|
127
|
+
* A read model (NI-10b): Salesforce 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. A Contact link carries its crmAccountId, so \"everyone at Acme\" is a join on this list. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
128
|
+
* The Accounts mirrored from this tenant\'s Salesforce org
|
|
129
|
+
*/
|
|
130
|
+
accountsRaw(requestParameters: AccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PageResponseSalesforceAccountResponse>>;
|
|
131
|
+
/**
|
|
132
|
+
* A read model (NI-10b): Salesforce 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. A Contact link carries its crmAccountId, so \"everyone at Acme\" is a join on this list. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
133
|
+
* The Accounts mirrored from this tenant\'s Salesforce org
|
|
134
|
+
*/
|
|
135
|
+
accounts(requestParameters: AccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PageResponseSalesforceAccountResponse>;
|
|
136
|
+
/**
|
|
137
|
+
* Returns the absolute Salesforce OAuth URL to navigate the browser to, carrying a signed state token that binds this tenant for the unauthenticated callback. environment selects the login host: production (the default) uses login.salesforce.com, sandbox uses test.salesforce.com. ⚠️ Choosing the wrong one fails at consent as invalid_grant, which reads as a wrong password — so offer the user the choice explicitly rather than defaulting silently. scopes is the exact list the consent screen will show, space-separated in the order Salesforce receives it; render it so an admin knows what is being asked before they are standing on the screen. The state field is for diagnostics only — it is already embedded in authorizeUrl and must not be parsed, stored or resent by a client. Makes no Salesforce call. Writes < 300ms. Requires API-key scope: integrations:write.
|
|
138
|
+
* Build the Salesforce consent URL that starts a connect
|
|
139
|
+
*/
|
|
140
|
+
authorizeUrlIntegrationsSalesforceRaw(requestParameters: AuthorizeUrlIntegrationsSalesforceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SalesforceAuthorizeUrlResponse>>;
|
|
141
|
+
/**
|
|
142
|
+
* Returns the absolute Salesforce OAuth URL to navigate the browser to, carrying a signed state token that binds this tenant for the unauthenticated callback. environment selects the login host: production (the default) uses login.salesforce.com, sandbox uses test.salesforce.com. ⚠️ Choosing the wrong one fails at consent as invalid_grant, which reads as a wrong password — so offer the user the choice explicitly rather than defaulting silently. scopes is the exact list the consent screen will show, space-separated in the order Salesforce receives it; render it so an admin knows what is being asked before they are standing on the screen. The state field is for diagnostics only — it is already embedded in authorizeUrl and must not be parsed, stored or resent by a client. Makes no Salesforce call. Writes < 300ms. Requires API-key scope: integrations:write.
|
|
143
|
+
* Build the Salesforce consent URL that starts a connect
|
|
144
|
+
*/
|
|
145
|
+
authorizeUrlIntegrationsSalesforce(requestParameters?: AuthorizeUrlIntegrationsSalesforceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SalesforceAuthorizeUrlResponse>;
|
|
146
|
+
/**
|
|
147
|
+
* Exists (NI-10b) so somebody building an automation can see the stage values their own org uses: a DEAL_STAGE_CHANGED flow triggers on stage, which is StageName\'s API value — Salesforce has no separate stage id, and the label is what an admin renames. closed and won are Salesforce\'s own IsClosed/IsWon, the answer to \"is this Closed Won\" however the org spells the stage. stageChangedAt is when we observed the move, not when Salesforce recorded it. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
148
|
+
* The Opportunities this tenant\'s syncs have observed, most recently moved first
|
|
149
|
+
*/
|
|
150
|
+
opportunitiesRaw(requestParameters: OpportunitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PageResponseSalesforceOpportunityResponse>>;
|
|
151
|
+
/**
|
|
152
|
+
* Exists (NI-10b) so somebody building an automation can see the stage values their own org uses: a DEAL_STAGE_CHANGED flow triggers on stage, which is StageName\'s API value — Salesforce has no separate stage id, and the label is what an admin renames. closed and won are Salesforce\'s own IsClosed/IsWon, the answer to \"is this Closed Won\" however the org spells the stage. stageChangedAt is when we observed the move, not when Salesforce recorded it. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
153
|
+
* The Opportunities this tenant\'s syncs have observed, most recently moved first
|
|
154
|
+
*/
|
|
155
|
+
opportunities(requestParameters: OpportunitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PageResponseSalesforceOpportunityResponse>;
|
|
156
|
+
/**
|
|
157
|
+
* Health comes from the shared connection substrate, so status here always matches GET /api/v1/integrations/salesforce. The counters are from the last run and are zero before the first one. activityWatermark is how far conversation history has been written onto CRM records, which is the only field that answers why a recent chat is not on the record yet. instanceUrl and environment are returned so an operator can confirm the integration points at the org they meant — connecting a sandbox by mistake is this integration\'s most likely misconfiguration. Never returns a token. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
158
|
+
* Whether this tenant has connected Salesforce, and what the last sync did
|
|
159
|
+
*/
|
|
160
|
+
statusIntegrationsSalesforceRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SalesforceStatusResponse>>;
|
|
161
|
+
/**
|
|
162
|
+
* Health comes from the shared connection substrate, so status here always matches GET /api/v1/integrations/salesforce. The counters are from the last run and are zero before the first one. activityWatermark is how far conversation history has been written onto CRM records, which is the only field that answers why a recent chat is not on the record yet. instanceUrl and environment are returned so an operator can confirm the integration points at the org they meant — connecting a sandbox by mistake is this integration\'s most likely misconfiguration. Never returns a token. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
163
|
+
* Whether this tenant has connected Salesforce, and what the last sync did
|
|
164
|
+
*/
|
|
165
|
+
statusIntegrationsSalesforce(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SalesforceStatusResponse>;
|
|
166
|
+
/**
|
|
167
|
+
* Five phases in order: Accounts, Contacts, Leads (when syncLeads is on), Opportunities (when syncOpportunities is on — each stage CHANGE is announced to automations as a CRM deal-stage event with vendor salesforce; stageChanges counts them, and against opportunitiesPulled it is the difference between modified and moved), then the conversation activity write-back — which, when pushPeopleAs is set, first CREATES the record for anybody the org lacks and counts it in peoplePushed. Contacts run before Leads because a person who is both — which a converted Lead makes routine — has their conversations filed against the Contact. Each phase is independently fallible, so an org that has spent its daily API allowance usually yields PARTIAL with phasesCompleted saying how much got through rather than an all-or-nothing failure. ⚠️ A Salesforce rate limit is a DAILY org budget shared with every other tool the customer has connected, so PARTIAL can persist for hours and does NOT mean the grant is broken — do not prompt a reconnect for it. Importing a Contact or Lead records NO consent on any channel; a CRM record is a sales record, not a permission list. Note that this platform\'s consent model is opt-out, so recording nothing leaves an imported person reachable exactly as a CSV import does; every one carries the salesforce tag so they can be segmented out. tokenRefreshes above 1 means the org\'s session timeout is shorter than a sync takes. 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.
|
|
168
|
+
* Run this tenant\'s Salesforce sync now
|
|
169
|
+
*/
|
|
170
|
+
syncNowIntegrationsSalesforceRaw(requestParameters: SyncNowIntegrationsSalesforceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SalesforceRunResponse>>;
|
|
171
|
+
/**
|
|
172
|
+
* Five phases in order: Accounts, Contacts, Leads (when syncLeads is on), Opportunities (when syncOpportunities is on — each stage CHANGE is announced to automations as a CRM deal-stage event with vendor salesforce; stageChanges counts them, and against opportunitiesPulled it is the difference between modified and moved), then the conversation activity write-back — which, when pushPeopleAs is set, first CREATES the record for anybody the org lacks and counts it in peoplePushed. Contacts run before Leads because a person who is both — which a converted Lead makes routine — has their conversations filed against the Contact. Each phase is independently fallible, so an org that has spent its daily API allowance usually yields PARTIAL with phasesCompleted saying how much got through rather than an all-or-nothing failure. ⚠️ A Salesforce rate limit is a DAILY org budget shared with every other tool the customer has connected, so PARTIAL can persist for hours and does NOT mean the grant is broken — do not prompt a reconnect for it. Importing a Contact or Lead records NO consent on any channel; a CRM record is a sales record, not a permission list. Note that this platform\'s consent model is opt-out, so recording nothing leaves an imported person reachable exactly as a CSV import does; every one carries the salesforce tag so they can be segmented out. tokenRefreshes above 1 means the org\'s session timeout is shorter than a sync takes. 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.
|
|
173
|
+
* Run this tenant\'s Salesforce sync now
|
|
174
|
+
*/
|
|
175
|
+
syncNowIntegrationsSalesforce(requestParameters?: SyncNowIntegrationsSalesforceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SalesforceRunResponse>;
|
|
176
|
+
/**
|
|
177
|
+
* A genuine partial update: send only the fields to change. syncLeads defaults TRUE, unlike NI-6\'s setting, because this one only reads — and Leads are usually the larger and more interesting half of an org for a messaging product. Turn it off for an org whose Lead table is a purchased list the sales team ignores. syncOpportunities (NI-10b) defaults TRUE and also only reads — but it ANNOUNCES: a CRM deal-stage automation whose trigger was never narrowed on vendor fires for ANY CRM, so a flow built for HubSpot and left unnarrowed starts being enrolled by Salesforce Opportunities the sweep after this is on. Turn it off here or narrow the flow. pushPeopleAs (NI-10b) is none|lead|contact and defaults none: the other two WRITE people into the customer\'s org, and Salesforce forces a choice HubSpot never did — a Lead needs no Account and may be treated as spam by the sales team; a Contact is the record they work from and arrives with no Account. Only people a conversation already exists with, only ones with an email, bounded per run. Importing a Contact or a Lead — or creating one — records NO consent on any channel. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
178
|
+
* Change how this tenant\'s Salesforce integration behaves
|
|
179
|
+
*/
|
|
180
|
+
updateSettingsIntegrationsSalesforceRaw(requestParameters: UpdateSettingsIntegrationsSalesforceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SalesforceStatusResponse>>;
|
|
181
|
+
/**
|
|
182
|
+
* A genuine partial update: send only the fields to change. syncLeads defaults TRUE, unlike NI-6\'s setting, because this one only reads — and Leads are usually the larger and more interesting half of an org for a messaging product. Turn it off for an org whose Lead table is a purchased list the sales team ignores. syncOpportunities (NI-10b) defaults TRUE and also only reads — but it ANNOUNCES: a CRM deal-stage automation whose trigger was never narrowed on vendor fires for ANY CRM, so a flow built for HubSpot and left unnarrowed starts being enrolled by Salesforce Opportunities the sweep after this is on. Turn it off here or narrow the flow. pushPeopleAs (NI-10b) is none|lead|contact and defaults none: the other two WRITE people into the customer\'s org, and Salesforce forces a choice HubSpot never did — a Lead needs no Account and may be treated as spam by the sales team; a Contact is the record they work from and arrives with no Account. Only people a conversation already exists with, only ones with an email, bounded per run. Importing a Contact or a Lead — or creating one — records NO consent on any channel. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
183
|
+
* Change how this tenant\'s Salesforce integration behaves
|
|
184
|
+
*/
|
|
185
|
+
updateSettingsIntegrationsSalesforce(requestParameters: UpdateSettingsIntegrationsSalesforceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SalesforceStatusResponse>;
|
|
186
|
+
}
|
|
@@ -0,0 +1,287 @@
|
|
|
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.SalesforceApi = void 0;
|
|
50
|
+
const runtime = __importStar(require("../runtime"));
|
|
51
|
+
const index_1 = require("../models/index");
|
|
52
|
+
/**
|
|
53
|
+
*
|
|
54
|
+
*/
|
|
55
|
+
class SalesforceApi extends runtime.BaseAPI {
|
|
56
|
+
/**
|
|
57
|
+
* A read model (NI-10b): Salesforce 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. A Contact link carries its crmAccountId, so \"everyone at Acme\" is a join on this list. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
58
|
+
* The Accounts mirrored from this tenant\'s Salesforce org
|
|
59
|
+
*/
|
|
60
|
+
async accountsRaw(requestParameters, initOverrides) {
|
|
61
|
+
if (requestParameters['pageable'] == null) {
|
|
62
|
+
throw new runtime.RequiredError('pageable', 'Required parameter "pageable" was null or undefined when calling accounts().');
|
|
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/salesforce/accounts`;
|
|
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.PageResponseSalesforceAccountResponseFromJSON)(jsonValue));
|
|
87
|
+
}
|
|
88
|
+
/**
|
|
89
|
+
* A read model (NI-10b): Salesforce 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. A Contact link carries its crmAccountId, so \"everyone at Acme\" is a join on this list. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
90
|
+
* The Accounts mirrored from this tenant\'s Salesforce org
|
|
91
|
+
*/
|
|
92
|
+
async accounts(requestParameters, initOverrides) {
|
|
93
|
+
const response = await this.accountsRaw(requestParameters, initOverrides);
|
|
94
|
+
return await response.value();
|
|
95
|
+
}
|
|
96
|
+
/**
|
|
97
|
+
* Returns the absolute Salesforce OAuth URL to navigate the browser to, carrying a signed state token that binds this tenant for the unauthenticated callback. environment selects the login host: production (the default) uses login.salesforce.com, sandbox uses test.salesforce.com. ⚠️ Choosing the wrong one fails at consent as invalid_grant, which reads as a wrong password — so offer the user the choice explicitly rather than defaulting silently. scopes is the exact list the consent screen will show, space-separated in the order Salesforce receives it; render it so an admin knows what is being asked before they are standing on the screen. The state field is for diagnostics only — it is already embedded in authorizeUrl and must not be parsed, stored or resent by a client. Makes no Salesforce call. Writes < 300ms. Requires API-key scope: integrations:write.
|
|
98
|
+
* Build the Salesforce consent URL that starts a connect
|
|
99
|
+
*/
|
|
100
|
+
async authorizeUrlIntegrationsSalesforceRaw(requestParameters, initOverrides) {
|
|
101
|
+
const queryParameters = {};
|
|
102
|
+
if (requestParameters['environment'] != null) {
|
|
103
|
+
queryParameters['environment'] = requestParameters['environment'];
|
|
104
|
+
}
|
|
105
|
+
const headerParameters = {};
|
|
106
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
107
|
+
headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
|
|
108
|
+
}
|
|
109
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
110
|
+
const token = this.configuration.accessToken;
|
|
111
|
+
const tokenString = await token("BearerAuth", []);
|
|
112
|
+
if (tokenString) {
|
|
113
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
let urlPath = `/api/v1/integrations/salesforce/authorize-url`;
|
|
117
|
+
const response = await this.request({
|
|
118
|
+
path: urlPath,
|
|
119
|
+
method: 'GET',
|
|
120
|
+
headers: headerParameters,
|
|
121
|
+
query: queryParameters,
|
|
122
|
+
}, initOverrides);
|
|
123
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SalesforceAuthorizeUrlResponseFromJSON)(jsonValue));
|
|
124
|
+
}
|
|
125
|
+
/**
|
|
126
|
+
* Returns the absolute Salesforce OAuth URL to navigate the browser to, carrying a signed state token that binds this tenant for the unauthenticated callback. environment selects the login host: production (the default) uses login.salesforce.com, sandbox uses test.salesforce.com. ⚠️ Choosing the wrong one fails at consent as invalid_grant, which reads as a wrong password — so offer the user the choice explicitly rather than defaulting silently. scopes is the exact list the consent screen will show, space-separated in the order Salesforce receives it; render it so an admin knows what is being asked before they are standing on the screen. The state field is for diagnostics only — it is already embedded in authorizeUrl and must not be parsed, stored or resent by a client. Makes no Salesforce call. Writes < 300ms. Requires API-key scope: integrations:write.
|
|
127
|
+
* Build the Salesforce consent URL that starts a connect
|
|
128
|
+
*/
|
|
129
|
+
async authorizeUrlIntegrationsSalesforce(requestParameters = {}, initOverrides) {
|
|
130
|
+
const response = await this.authorizeUrlIntegrationsSalesforceRaw(requestParameters, initOverrides);
|
|
131
|
+
return await response.value();
|
|
132
|
+
}
|
|
133
|
+
/**
|
|
134
|
+
* Exists (NI-10b) so somebody building an automation can see the stage values their own org uses: a DEAL_STAGE_CHANGED flow triggers on stage, which is StageName\'s API value — Salesforce has no separate stage id, and the label is what an admin renames. closed and won are Salesforce\'s own IsClosed/IsWon, the answer to \"is this Closed Won\" however the org spells the stage. stageChangedAt is when we observed the move, not when Salesforce recorded it. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
135
|
+
* The Opportunities this tenant\'s syncs have observed, most recently moved first
|
|
136
|
+
*/
|
|
137
|
+
async opportunitiesRaw(requestParameters, initOverrides) {
|
|
138
|
+
if (requestParameters['pageable'] == null) {
|
|
139
|
+
throw new runtime.RequiredError('pageable', 'Required parameter "pageable" was null or undefined when calling opportunities().');
|
|
140
|
+
}
|
|
141
|
+
const queryParameters = {};
|
|
142
|
+
if (requestParameters['pageable'] != null) {
|
|
143
|
+
queryParameters['pageable'] = requestParameters['pageable'];
|
|
144
|
+
}
|
|
145
|
+
const headerParameters = {};
|
|
146
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
147
|
+
headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
|
|
148
|
+
}
|
|
149
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
150
|
+
const token = this.configuration.accessToken;
|
|
151
|
+
const tokenString = await token("BearerAuth", []);
|
|
152
|
+
if (tokenString) {
|
|
153
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
154
|
+
}
|
|
155
|
+
}
|
|
156
|
+
let urlPath = `/api/v1/integrations/salesforce/opportunities`;
|
|
157
|
+
const response = await this.request({
|
|
158
|
+
path: urlPath,
|
|
159
|
+
method: 'GET',
|
|
160
|
+
headers: headerParameters,
|
|
161
|
+
query: queryParameters,
|
|
162
|
+
}, initOverrides);
|
|
163
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PageResponseSalesforceOpportunityResponseFromJSON)(jsonValue));
|
|
164
|
+
}
|
|
165
|
+
/**
|
|
166
|
+
* Exists (NI-10b) so somebody building an automation can see the stage values their own org uses: a DEAL_STAGE_CHANGED flow triggers on stage, which is StageName\'s API value — Salesforce has no separate stage id, and the label is what an admin renames. closed and won are Salesforce\'s own IsClosed/IsWon, the answer to \"is this Closed Won\" however the org spells the stage. stageChangedAt is when we observed the move, not when Salesforce recorded it. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
167
|
+
* The Opportunities this tenant\'s syncs have observed, most recently moved first
|
|
168
|
+
*/
|
|
169
|
+
async opportunities(requestParameters, initOverrides) {
|
|
170
|
+
const response = await this.opportunitiesRaw(requestParameters, initOverrides);
|
|
171
|
+
return await response.value();
|
|
172
|
+
}
|
|
173
|
+
/**
|
|
174
|
+
* Health comes from the shared connection substrate, so status here always matches GET /api/v1/integrations/salesforce. The counters are from the last run and are zero before the first one. activityWatermark is how far conversation history has been written onto CRM records, which is the only field that answers why a recent chat is not on the record yet. instanceUrl and environment are returned so an operator can confirm the integration points at the org they meant — connecting a sandbox by mistake is this integration\'s most likely misconfiguration. Never returns a token. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
175
|
+
* Whether this tenant has connected Salesforce, and what the last sync did
|
|
176
|
+
*/
|
|
177
|
+
async statusIntegrationsSalesforceRaw(initOverrides) {
|
|
178
|
+
const queryParameters = {};
|
|
179
|
+
const headerParameters = {};
|
|
180
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
181
|
+
headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
|
|
182
|
+
}
|
|
183
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
184
|
+
const token = this.configuration.accessToken;
|
|
185
|
+
const tokenString = await token("BearerAuth", []);
|
|
186
|
+
if (tokenString) {
|
|
187
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
188
|
+
}
|
|
189
|
+
}
|
|
190
|
+
let urlPath = `/api/v1/integrations/salesforce`;
|
|
191
|
+
const response = await this.request({
|
|
192
|
+
path: urlPath,
|
|
193
|
+
method: 'GET',
|
|
194
|
+
headers: headerParameters,
|
|
195
|
+
query: queryParameters,
|
|
196
|
+
}, initOverrides);
|
|
197
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SalesforceStatusResponseFromJSON)(jsonValue));
|
|
198
|
+
}
|
|
199
|
+
/**
|
|
200
|
+
* Health comes from the shared connection substrate, so status here always matches GET /api/v1/integrations/salesforce. The counters are from the last run and are zero before the first one. activityWatermark is how far conversation history has been written onto CRM records, which is the only field that answers why a recent chat is not on the record yet. instanceUrl and environment are returned so an operator can confirm the integration points at the org they meant — connecting a sandbox by mistake is this integration\'s most likely misconfiguration. Never returns a token. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
201
|
+
* Whether this tenant has connected Salesforce, and what the last sync did
|
|
202
|
+
*/
|
|
203
|
+
async statusIntegrationsSalesforce(initOverrides) {
|
|
204
|
+
const response = await this.statusIntegrationsSalesforceRaw(initOverrides);
|
|
205
|
+
return await response.value();
|
|
206
|
+
}
|
|
207
|
+
/**
|
|
208
|
+
* Five phases in order: Accounts, Contacts, Leads (when syncLeads is on), Opportunities (when syncOpportunities is on — each stage CHANGE is announced to automations as a CRM deal-stage event with vendor salesforce; stageChanges counts them, and against opportunitiesPulled it is the difference between modified and moved), then the conversation activity write-back — which, when pushPeopleAs is set, first CREATES the record for anybody the org lacks and counts it in peoplePushed. Contacts run before Leads because a person who is both — which a converted Lead makes routine — has their conversations filed against the Contact. Each phase is independently fallible, so an org that has spent its daily API allowance usually yields PARTIAL with phasesCompleted saying how much got through rather than an all-or-nothing failure. ⚠️ A Salesforce rate limit is a DAILY org budget shared with every other tool the customer has connected, so PARTIAL can persist for hours and does NOT mean the grant is broken — do not prompt a reconnect for it. Importing a Contact or Lead records NO consent on any channel; a CRM record is a sales record, not a permission list. Note that this platform\'s consent model is opt-out, so recording nothing leaves an imported person reachable exactly as a CSV import does; every one carries the salesforce tag so they can be segmented out. tokenRefreshes above 1 means the org\'s session timeout is shorter than a sync takes. 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.
|
|
209
|
+
* Run this tenant\'s Salesforce sync now
|
|
210
|
+
*/
|
|
211
|
+
async syncNowIntegrationsSalesforceRaw(requestParameters, initOverrides) {
|
|
212
|
+
const queryParameters = {};
|
|
213
|
+
const headerParameters = {};
|
|
214
|
+
if (requestParameters['xIdempotencyKey'] != null) {
|
|
215
|
+
headerParameters['X-Idempotency-Key'] = String(requestParameters['xIdempotencyKey']);
|
|
216
|
+
}
|
|
217
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
218
|
+
headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
|
|
219
|
+
}
|
|
220
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
221
|
+
const token = this.configuration.accessToken;
|
|
222
|
+
const tokenString = await token("BearerAuth", []);
|
|
223
|
+
if (tokenString) {
|
|
224
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
225
|
+
}
|
|
226
|
+
}
|
|
227
|
+
let urlPath = `/api/v1/integrations/salesforce/sync`;
|
|
228
|
+
const response = await this.request({
|
|
229
|
+
path: urlPath,
|
|
230
|
+
method: 'POST',
|
|
231
|
+
headers: headerParameters,
|
|
232
|
+
query: queryParameters,
|
|
233
|
+
}, initOverrides);
|
|
234
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SalesforceRunResponseFromJSON)(jsonValue));
|
|
235
|
+
}
|
|
236
|
+
/**
|
|
237
|
+
* Five phases in order: Accounts, Contacts, Leads (when syncLeads is on), Opportunities (when syncOpportunities is on — each stage CHANGE is announced to automations as a CRM deal-stage event with vendor salesforce; stageChanges counts them, and against opportunitiesPulled it is the difference between modified and moved), then the conversation activity write-back — which, when pushPeopleAs is set, first CREATES the record for anybody the org lacks and counts it in peoplePushed. Contacts run before Leads because a person who is both — which a converted Lead makes routine — has their conversations filed against the Contact. Each phase is independently fallible, so an org that has spent its daily API allowance usually yields PARTIAL with phasesCompleted saying how much got through rather than an all-or-nothing failure. ⚠️ A Salesforce rate limit is a DAILY org budget shared with every other tool the customer has connected, so PARTIAL can persist for hours and does NOT mean the grant is broken — do not prompt a reconnect for it. Importing a Contact or Lead records NO consent on any channel; a CRM record is a sales record, not a permission list. Note that this platform\'s consent model is opt-out, so recording nothing leaves an imported person reachable exactly as a CSV import does; every one carries the salesforce tag so they can be segmented out. tokenRefreshes above 1 means the org\'s session timeout is shorter than a sync takes. 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.
|
|
238
|
+
* Run this tenant\'s Salesforce sync now
|
|
239
|
+
*/
|
|
240
|
+
async syncNowIntegrationsSalesforce(requestParameters = {}, initOverrides) {
|
|
241
|
+
const response = await this.syncNowIntegrationsSalesforceRaw(requestParameters, initOverrides);
|
|
242
|
+
return await response.value();
|
|
243
|
+
}
|
|
244
|
+
/**
|
|
245
|
+
* A genuine partial update: send only the fields to change. syncLeads defaults TRUE, unlike NI-6\'s setting, because this one only reads — and Leads are usually the larger and more interesting half of an org for a messaging product. Turn it off for an org whose Lead table is a purchased list the sales team ignores. syncOpportunities (NI-10b) defaults TRUE and also only reads — but it ANNOUNCES: a CRM deal-stage automation whose trigger was never narrowed on vendor fires for ANY CRM, so a flow built for HubSpot and left unnarrowed starts being enrolled by Salesforce Opportunities the sweep after this is on. Turn it off here or narrow the flow. pushPeopleAs (NI-10b) is none|lead|contact and defaults none: the other two WRITE people into the customer\'s org, and Salesforce forces a choice HubSpot never did — a Lead needs no Account and may be treated as spam by the sales team; a Contact is the record they work from and arrives with no Account. Only people a conversation already exists with, only ones with an email, bounded per run. Importing a Contact or a Lead — or creating one — records NO consent on any channel. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
246
|
+
* Change how this tenant\'s Salesforce integration behaves
|
|
247
|
+
*/
|
|
248
|
+
async updateSettingsIntegrationsSalesforceRaw(requestParameters, initOverrides) {
|
|
249
|
+
if (requestParameters['updateSalesforceSettingsRequest'] == null) {
|
|
250
|
+
throw new runtime.RequiredError('updateSalesforceSettingsRequest', 'Required parameter "updateSalesforceSettingsRequest" was null or undefined when calling updateSettingsIntegrationsSalesforce().');
|
|
251
|
+
}
|
|
252
|
+
const queryParameters = {};
|
|
253
|
+
const headerParameters = {};
|
|
254
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
255
|
+
if (requestParameters['xIdempotencyKey'] != null) {
|
|
256
|
+
headerParameters['X-Idempotency-Key'] = String(requestParameters['xIdempotencyKey']);
|
|
257
|
+
}
|
|
258
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
259
|
+
headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
|
|
260
|
+
}
|
|
261
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
262
|
+
const token = this.configuration.accessToken;
|
|
263
|
+
const tokenString = await token("BearerAuth", []);
|
|
264
|
+
if (tokenString) {
|
|
265
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
266
|
+
}
|
|
267
|
+
}
|
|
268
|
+
let urlPath = `/api/v1/integrations/salesforce/settings`;
|
|
269
|
+
const response = await this.request({
|
|
270
|
+
path: urlPath,
|
|
271
|
+
method: 'PATCH',
|
|
272
|
+
headers: headerParameters,
|
|
273
|
+
query: queryParameters,
|
|
274
|
+
body: (0, index_1.UpdateSalesforceSettingsRequestToJSON)(requestParameters['updateSalesforceSettingsRequest']),
|
|
275
|
+
}, initOverrides);
|
|
276
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SalesforceStatusResponseFromJSON)(jsonValue));
|
|
277
|
+
}
|
|
278
|
+
/**
|
|
279
|
+
* A genuine partial update: send only the fields to change. syncLeads defaults TRUE, unlike NI-6\'s setting, because this one only reads — and Leads are usually the larger and more interesting half of an org for a messaging product. Turn it off for an org whose Lead table is a purchased list the sales team ignores. syncOpportunities (NI-10b) defaults TRUE and also only reads — but it ANNOUNCES: a CRM deal-stage automation whose trigger was never narrowed on vendor fires for ANY CRM, so a flow built for HubSpot and left unnarrowed starts being enrolled by Salesforce Opportunities the sweep after this is on. Turn it off here or narrow the flow. pushPeopleAs (NI-10b) is none|lead|contact and defaults none: the other two WRITE people into the customer\'s org, and Salesforce forces a choice HubSpot never did — a Lead needs no Account and may be treated as spam by the sales team; a Contact is the record they work from and arrives with no Account. Only people a conversation already exists with, only ones with an email, bounded per run. Importing a Contact or a Lead — or creating one — records NO consent on any channel. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
280
|
+
* Change how this tenant\'s Salesforce integration behaves
|
|
281
|
+
*/
|
|
282
|
+
async updateSettingsIntegrationsSalesforce(requestParameters, initOverrides) {
|
|
283
|
+
const response = await this.updateSettingsIntegrationsSalesforceRaw(requestParameters, initOverrides);
|
|
284
|
+
return await response.value();
|
|
285
|
+
}
|
|
286
|
+
}
|
|
287
|
+
exports.SalesforceApi = SalesforceApi;
|
|
@@ -0,0 +1,58 @@
|
|
|
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
|
+
export interface CallbackAuthSalesforceRequest {
|
|
14
|
+
code?: string;
|
|
15
|
+
state?: string;
|
|
16
|
+
error?: string;
|
|
17
|
+
errorDescription?: string;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* SalesforceOAuthCallbackApi - interface
|
|
21
|
+
*
|
|
22
|
+
* @export
|
|
23
|
+
* @interface SalesforceOAuthCallbackApiInterface
|
|
24
|
+
*/
|
|
25
|
+
export interface SalesforceOAuthCallbackApiInterface {
|
|
26
|
+
/**
|
|
27
|
+
* Verifies the signed state, exchanges the authorization code for a grant, proves the grant can query the org, and stores it — then redirects the browser back into the console. Every outcome is a 302, including every failure: a person is looking at this in a browser and a raw JSON error is not something they can act on. Not called by any client directly — it is the connected app\'s registered Callback URL, and Salesforce matches that value exactly. Spends two Salesforce round trips (the code exchange, then an org query that proves the grant works), so a real connect is dominated by Salesforce\'s own latency: < 2s.
|
|
28
|
+
* @summary Handle Salesforce\'s connect redirect
|
|
29
|
+
* @param {string} [code]
|
|
30
|
+
* @param {string} [state]
|
|
31
|
+
* @param {string} [error]
|
|
32
|
+
* @param {string} [errorDescription]
|
|
33
|
+
* @param {*} [options] Override http request option.
|
|
34
|
+
* @throws {RequiredError}
|
|
35
|
+
* @memberof SalesforceOAuthCallbackApiInterface
|
|
36
|
+
*/
|
|
37
|
+
callbackAuthSalesforceRaw(requestParameters: CallbackAuthSalesforceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
38
|
+
/**
|
|
39
|
+
* Verifies the signed state, exchanges the authorization code for a grant, proves the grant can query the org, and stores it — then redirects the browser back into the console. Every outcome is a 302, including every failure: a person is looking at this in a browser and a raw JSON error is not something they can act on. Not called by any client directly — it is the connected app\'s registered Callback URL, and Salesforce matches that value exactly. Spends two Salesforce round trips (the code exchange, then an org query that proves the grant works), so a real connect is dominated by Salesforce\'s own latency: < 2s.
|
|
40
|
+
* Handle Salesforce\'s connect redirect
|
|
41
|
+
*/
|
|
42
|
+
callbackAuthSalesforce(requestParameters: CallbackAuthSalesforceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
*
|
|
46
|
+
*/
|
|
47
|
+
export declare class SalesforceOAuthCallbackApi extends runtime.BaseAPI implements SalesforceOAuthCallbackApiInterface {
|
|
48
|
+
/**
|
|
49
|
+
* Verifies the signed state, exchanges the authorization code for a grant, proves the grant can query the org, and stores it — then redirects the browser back into the console. Every outcome is a 302, including every failure: a person is looking at this in a browser and a raw JSON error is not something they can act on. Not called by any client directly — it is the connected app\'s registered Callback URL, and Salesforce matches that value exactly. Spends two Salesforce round trips (the code exchange, then an org query that proves the grant works), so a real connect is dominated by Salesforce\'s own latency: < 2s.
|
|
50
|
+
* Handle Salesforce\'s connect redirect
|
|
51
|
+
*/
|
|
52
|
+
callbackAuthSalesforceRaw(requestParameters: CallbackAuthSalesforceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
53
|
+
/**
|
|
54
|
+
* Verifies the signed state, exchanges the authorization code for a grant, proves the grant can query the org, and stores it — then redirects the browser back into the console. Every outcome is a 302, including every failure: a person is looking at this in a browser and a raw JSON error is not something they can act on. Not called by any client directly — it is the connected app\'s registered Callback URL, and Salesforce matches that value exactly. Spends two Salesforce round trips (the code exchange, then an org query that proves the grant works), so a real connect is dominated by Salesforce\'s own latency: < 2s.
|
|
55
|
+
* Handle Salesforce\'s connect redirect
|
|
56
|
+
*/
|
|
57
|
+
callbackAuthSalesforce(requestParameters?: CallbackAuthSalesforceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
58
|
+
}
|