@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,144 @@
|
|
|
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 { CdpVendorResponse, ConnectCdpRequest, CursorPageCdpInboundEventResponse, UpdateCdpSettingsRequest } from '../models/index';
|
|
14
|
+
export interface ConnectIntegrationsCdpRequest {
|
|
15
|
+
vendor: string;
|
|
16
|
+
connectCdpRequest: ConnectCdpRequest;
|
|
17
|
+
xIdempotencyKey?: string;
|
|
18
|
+
}
|
|
19
|
+
export interface EventsIntegrationsRequest {
|
|
20
|
+
vendor: string;
|
|
21
|
+
eventName?: string;
|
|
22
|
+
cursor?: string;
|
|
23
|
+
limit?: number;
|
|
24
|
+
}
|
|
25
|
+
export interface UpdateSettingsIntegrationsCdpRequest {
|
|
26
|
+
vendor: string;
|
|
27
|
+
updateCdpSettingsRequest: UpdateCdpSettingsRequest;
|
|
28
|
+
xIdempotencyKey?: string;
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* CdpApi - interface
|
|
32
|
+
*
|
|
33
|
+
* @export
|
|
34
|
+
* @interface CdpApiInterface
|
|
35
|
+
*/
|
|
36
|
+
export interface CdpApiInterface {
|
|
37
|
+
/**
|
|
38
|
+
* Both take credentials.writeKey, copied from your source\'s settings. RudderStack additionally requires credentials.dataPlaneUrl, an absolute https:// address: it is the hostname events are sent to and there is no default, so a connection without one is refused before anything is stored. Both accept an optional credentials.sharedSecret; set the same value on the vendor\'s webhook destination and inbound deliveries are signature-verified as well as routed by the secret URL. NO VENDOR CALL IS MADE: neither platform exposes anything that validates a write key without writing a synthetic event into your own analytics stream, so the check is a local shape check and a mistyped key is discovered by the first forward, which marks the connection DEGRADED. Returns inboundUrl ONCE — paste it into the vendor\'s Webhooks destination. It is never returned again and reconnecting rotates it. Credentials are encrypted at rest and are never returned by any endpoint. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
39
|
+
* @summary Connect Segment or RudderStack for this workspace
|
|
40
|
+
* @param {string} vendor
|
|
41
|
+
* @param {ConnectCdpRequest} connectCdpRequest
|
|
42
|
+
* @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.
|
|
43
|
+
* @param {*} [options] Override http request option.
|
|
44
|
+
* @throws {RequiredError}
|
|
45
|
+
* @memberof CdpApiInterface
|
|
46
|
+
*/
|
|
47
|
+
connectIntegrationsCdpRaw(requestParameters: ConnectIntegrationsCdpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CdpVendorResponse>>;
|
|
48
|
+
/**
|
|
49
|
+
* Both take credentials.writeKey, copied from your source\'s settings. RudderStack additionally requires credentials.dataPlaneUrl, an absolute https:// address: it is the hostname events are sent to and there is no default, so a connection without one is refused before anything is stored. Both accept an optional credentials.sharedSecret; set the same value on the vendor\'s webhook destination and inbound deliveries are signature-verified as well as routed by the secret URL. NO VENDOR CALL IS MADE: neither platform exposes anything that validates a write key without writing a synthetic event into your own analytics stream, so the check is a local shape check and a mistyped key is discovered by the first forward, which marks the connection DEGRADED. Returns inboundUrl ONCE — paste it into the vendor\'s Webhooks destination. It is never returned again and reconnecting rotates it. Credentials are encrypted at rest and are never returned by any endpoint. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
50
|
+
* Connect Segment or RudderStack for this workspace
|
|
51
|
+
*/
|
|
52
|
+
connectIntegrationsCdp(requestParameters: ConnectIntegrationsCdpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CdpVendorResponse>;
|
|
53
|
+
/**
|
|
54
|
+
* The answer to \'my event fired in Segment, why did nothing happen here\'. Every authenticated delivery is recorded with what it did: CONTACT_UPSERTED, CONTACT_NOT_CREATED (an identify for somebody you do not hold, with identifyCreatesContacts off), TRACK_ANNOUNCED, TRACK_UNRESOLVED (the commonest by far — a CDP tracks anonymous visitors), IGNORED (a page/screen/group/alias call, or a duplicate) or UNPARSEABLE. Cursor-paginated on the CDP\'s own timestamp, default 25 and max 100. The identity the CDP named is deliberately NOT returned — it is encrypted at rest as PII; contactId answers the same question better. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
55
|
+
* @summary What this CDP has delivered, newest first
|
|
56
|
+
* @param {string} vendor
|
|
57
|
+
* @param {string} [eventName]
|
|
58
|
+
* @param {string} [cursor]
|
|
59
|
+
* @param {number} [limit]
|
|
60
|
+
* @param {*} [options] Override http request option.
|
|
61
|
+
* @throws {RequiredError}
|
|
62
|
+
* @memberof CdpApiInterface
|
|
63
|
+
*/
|
|
64
|
+
eventsIntegrationsRaw(requestParameters: EventsIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CursorPageCdpInboundEventResponse>>;
|
|
65
|
+
/**
|
|
66
|
+
* The answer to \'my event fired in Segment, why did nothing happen here\'. Every authenticated delivery is recorded with what it did: CONTACT_UPSERTED, CONTACT_NOT_CREATED (an identify for somebody you do not hold, with identifyCreatesContacts off), TRACK_ANNOUNCED, TRACK_UNRESOLVED (the commonest by far — a CDP tracks anonymous visitors), IGNORED (a page/screen/group/alias call, or a duplicate) or UNPARSEABLE. Cursor-paginated on the CDP\'s own timestamp, default 25 and max 100. The identity the CDP named is deliberately NOT returned — it is encrypted at rest as PII; contactId answers the same question better. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
67
|
+
* What this CDP has delivered, newest first
|
|
68
|
+
*/
|
|
69
|
+
eventsIntegrations(requestParameters: EventsIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CursorPageCdpInboundEventResponse>;
|
|
70
|
+
/**
|
|
71
|
+
* identifyCreatesContacts governs whether an inbound identify for somebody this workspace does not hold may create a contact; it defaults FALSE on connect, because a CDP holds every visitor your site has ever seen. Contacts created this way carry no consent on any channel — they can be segmented and reported on, and cannot be messaged. forwardEnabled and forwardedEvents govern the outbound half: send a list to narrow forwardedEvents, [\"*\"] alone to reset it to every subscribable type (the default a connection starts with), or an empty list to forward nothing. Any omitted or null field keeps its current value — forwardedEvents included, which is why the reset is an explicit value rather than null. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
72
|
+
* @summary Change what this CDP does in each direction
|
|
73
|
+
* @param {string} vendor
|
|
74
|
+
* @param {UpdateCdpSettingsRequest} updateCdpSettingsRequest
|
|
75
|
+
* @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.
|
|
76
|
+
* @param {*} [options] Override http request option.
|
|
77
|
+
* @throws {RequiredError}
|
|
78
|
+
* @memberof CdpApiInterface
|
|
79
|
+
*/
|
|
80
|
+
updateSettingsIntegrationsCdpRaw(requestParameters: UpdateSettingsIntegrationsCdpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CdpVendorResponse>>;
|
|
81
|
+
/**
|
|
82
|
+
* identifyCreatesContacts governs whether an inbound identify for somebody this workspace does not hold may create a contact; it defaults FALSE on connect, because a CDP holds every visitor your site has ever seen. Contacts created this way carry no consent on any channel — they can be segmented and reported on, and cannot be messaged. forwardEnabled and forwardedEvents govern the outbound half: send a list to narrow forwardedEvents, [\"*\"] alone to reset it to every subscribable type (the default a connection starts with), or an empty list to forward nothing. Any omitted or null field keeps its current value — forwardedEvents included, which is why the reset is an explicit value rather than null. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
83
|
+
* Change what this CDP does in each direction
|
|
84
|
+
*/
|
|
85
|
+
updateSettingsIntegrationsCdp(requestParameters: UpdateSettingsIntegrationsCdpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CdpVendorResponse>;
|
|
86
|
+
/**
|
|
87
|
+
* Status comes from the shared connection substrate, so a vendor\'s status here always matches GET /api/v1/integrations/{vendor}. lastErrorCode is the last forwarding failure and is the health signal for these vendors: neither publishes anything a probe could read, so a connection\'s health is what the last real forward did. forwardedEvents null means every subscribable type; an empty list means none. inboundUrl is always null here — it is returned by connect only. Never returns a credential. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
88
|
+
* @summary List both customer data platforms and this workspace\'s settings for them
|
|
89
|
+
* @param {*} [options] Override http request option.
|
|
90
|
+
* @throws {RequiredError}
|
|
91
|
+
* @memberof CdpApiInterface
|
|
92
|
+
*/
|
|
93
|
+
vendorsIntegrationsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CdpVendorResponse>>>;
|
|
94
|
+
/**
|
|
95
|
+
* Status comes from the shared connection substrate, so a vendor\'s status here always matches GET /api/v1/integrations/{vendor}. lastErrorCode is the last forwarding failure and is the health signal for these vendors: neither publishes anything a probe could read, so a connection\'s health is what the last real forward did. forwardedEvents null means every subscribable type; an empty list means none. inboundUrl is always null here — it is returned by connect only. Never returns a credential. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
96
|
+
* List both customer data platforms and this workspace\'s settings for them
|
|
97
|
+
*/
|
|
98
|
+
vendorsIntegrations(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CdpVendorResponse>>;
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
*
|
|
102
|
+
*/
|
|
103
|
+
export declare class CdpApi extends runtime.BaseAPI implements CdpApiInterface {
|
|
104
|
+
/**
|
|
105
|
+
* Both take credentials.writeKey, copied from your source\'s settings. RudderStack additionally requires credentials.dataPlaneUrl, an absolute https:// address: it is the hostname events are sent to and there is no default, so a connection without one is refused before anything is stored. Both accept an optional credentials.sharedSecret; set the same value on the vendor\'s webhook destination and inbound deliveries are signature-verified as well as routed by the secret URL. NO VENDOR CALL IS MADE: neither platform exposes anything that validates a write key without writing a synthetic event into your own analytics stream, so the check is a local shape check and a mistyped key is discovered by the first forward, which marks the connection DEGRADED. Returns inboundUrl ONCE — paste it into the vendor\'s Webhooks destination. It is never returned again and reconnecting rotates it. Credentials are encrypted at rest and are never returned by any endpoint. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
106
|
+
* Connect Segment or RudderStack for this workspace
|
|
107
|
+
*/
|
|
108
|
+
connectIntegrationsCdpRaw(requestParameters: ConnectIntegrationsCdpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CdpVendorResponse>>;
|
|
109
|
+
/**
|
|
110
|
+
* Both take credentials.writeKey, copied from your source\'s settings. RudderStack additionally requires credentials.dataPlaneUrl, an absolute https:// address: it is the hostname events are sent to and there is no default, so a connection without one is refused before anything is stored. Both accept an optional credentials.sharedSecret; set the same value on the vendor\'s webhook destination and inbound deliveries are signature-verified as well as routed by the secret URL. NO VENDOR CALL IS MADE: neither platform exposes anything that validates a write key without writing a synthetic event into your own analytics stream, so the check is a local shape check and a mistyped key is discovered by the first forward, which marks the connection DEGRADED. Returns inboundUrl ONCE — paste it into the vendor\'s Webhooks destination. It is never returned again and reconnecting rotates it. Credentials are encrypted at rest and are never returned by any endpoint. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
111
|
+
* Connect Segment or RudderStack for this workspace
|
|
112
|
+
*/
|
|
113
|
+
connectIntegrationsCdp(requestParameters: ConnectIntegrationsCdpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CdpVendorResponse>;
|
|
114
|
+
/**
|
|
115
|
+
* The answer to \'my event fired in Segment, why did nothing happen here\'. Every authenticated delivery is recorded with what it did: CONTACT_UPSERTED, CONTACT_NOT_CREATED (an identify for somebody you do not hold, with identifyCreatesContacts off), TRACK_ANNOUNCED, TRACK_UNRESOLVED (the commonest by far — a CDP tracks anonymous visitors), IGNORED (a page/screen/group/alias call, or a duplicate) or UNPARSEABLE. Cursor-paginated on the CDP\'s own timestamp, default 25 and max 100. The identity the CDP named is deliberately NOT returned — it is encrypted at rest as PII; contactId answers the same question better. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
116
|
+
* What this CDP has delivered, newest first
|
|
117
|
+
*/
|
|
118
|
+
eventsIntegrationsRaw(requestParameters: EventsIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CursorPageCdpInboundEventResponse>>;
|
|
119
|
+
/**
|
|
120
|
+
* The answer to \'my event fired in Segment, why did nothing happen here\'. Every authenticated delivery is recorded with what it did: CONTACT_UPSERTED, CONTACT_NOT_CREATED (an identify for somebody you do not hold, with identifyCreatesContacts off), TRACK_ANNOUNCED, TRACK_UNRESOLVED (the commonest by far — a CDP tracks anonymous visitors), IGNORED (a page/screen/group/alias call, or a duplicate) or UNPARSEABLE. Cursor-paginated on the CDP\'s own timestamp, default 25 and max 100. The identity the CDP named is deliberately NOT returned — it is encrypted at rest as PII; contactId answers the same question better. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
121
|
+
* What this CDP has delivered, newest first
|
|
122
|
+
*/
|
|
123
|
+
eventsIntegrations(requestParameters: EventsIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CursorPageCdpInboundEventResponse>;
|
|
124
|
+
/**
|
|
125
|
+
* identifyCreatesContacts governs whether an inbound identify for somebody this workspace does not hold may create a contact; it defaults FALSE on connect, because a CDP holds every visitor your site has ever seen. Contacts created this way carry no consent on any channel — they can be segmented and reported on, and cannot be messaged. forwardEnabled and forwardedEvents govern the outbound half: send a list to narrow forwardedEvents, [\"*\"] alone to reset it to every subscribable type (the default a connection starts with), or an empty list to forward nothing. Any omitted or null field keeps its current value — forwardedEvents included, which is why the reset is an explicit value rather than null. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
126
|
+
* Change what this CDP does in each direction
|
|
127
|
+
*/
|
|
128
|
+
updateSettingsIntegrationsCdpRaw(requestParameters: UpdateSettingsIntegrationsCdpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CdpVendorResponse>>;
|
|
129
|
+
/**
|
|
130
|
+
* identifyCreatesContacts governs whether an inbound identify for somebody this workspace does not hold may create a contact; it defaults FALSE on connect, because a CDP holds every visitor your site has ever seen. Contacts created this way carry no consent on any channel — they can be segmented and reported on, and cannot be messaged. forwardEnabled and forwardedEvents govern the outbound half: send a list to narrow forwardedEvents, [\"*\"] alone to reset it to every subscribable type (the default a connection starts with), or an empty list to forward nothing. Any omitted or null field keeps its current value — forwardedEvents included, which is why the reset is an explicit value rather than null. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
131
|
+
* Change what this CDP does in each direction
|
|
132
|
+
*/
|
|
133
|
+
updateSettingsIntegrationsCdp(requestParameters: UpdateSettingsIntegrationsCdpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CdpVendorResponse>;
|
|
134
|
+
/**
|
|
135
|
+
* Status comes from the shared connection substrate, so a vendor\'s status here always matches GET /api/v1/integrations/{vendor}. lastErrorCode is the last forwarding failure and is the health signal for these vendors: neither publishes anything a probe could read, so a connection\'s health is what the last real forward did. forwardedEvents null means every subscribable type; an empty list means none. inboundUrl is always null here — it is returned by connect only. Never returns a credential. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
136
|
+
* List both customer data platforms and this workspace\'s settings for them
|
|
137
|
+
*/
|
|
138
|
+
vendorsIntegrationsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CdpVendorResponse>>>;
|
|
139
|
+
/**
|
|
140
|
+
* Status comes from the shared connection substrate, so a vendor\'s status here always matches GET /api/v1/integrations/{vendor}. lastErrorCode is the last forwarding failure and is the health signal for these vendors: neither publishes anything a probe could read, so a connection\'s health is what the last real forward did. forwardedEvents null means every subscribable type; an empty list means none. inboundUrl is always null here — it is returned by connect only. Never returns a credential. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
141
|
+
* List both customer data platforms and this workspace\'s settings for them
|
|
142
|
+
*/
|
|
143
|
+
vendorsIntegrations(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CdpVendorResponse>>;
|
|
144
|
+
}
|
|
@@ -0,0 +1,230 @@
|
|
|
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.CdpApi = void 0;
|
|
50
|
+
const runtime = __importStar(require("../runtime"));
|
|
51
|
+
const index_1 = require("../models/index");
|
|
52
|
+
/**
|
|
53
|
+
*
|
|
54
|
+
*/
|
|
55
|
+
class CdpApi extends runtime.BaseAPI {
|
|
56
|
+
/**
|
|
57
|
+
* Both take credentials.writeKey, copied from your source\'s settings. RudderStack additionally requires credentials.dataPlaneUrl, an absolute https:// address: it is the hostname events are sent to and there is no default, so a connection without one is refused before anything is stored. Both accept an optional credentials.sharedSecret; set the same value on the vendor\'s webhook destination and inbound deliveries are signature-verified as well as routed by the secret URL. NO VENDOR CALL IS MADE: neither platform exposes anything that validates a write key without writing a synthetic event into your own analytics stream, so the check is a local shape check and a mistyped key is discovered by the first forward, which marks the connection DEGRADED. Returns inboundUrl ONCE — paste it into the vendor\'s Webhooks destination. It is never returned again and reconnecting rotates it. Credentials are encrypted at rest and are never returned by any endpoint. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
58
|
+
* Connect Segment or RudderStack for this workspace
|
|
59
|
+
*/
|
|
60
|
+
async connectIntegrationsCdpRaw(requestParameters, initOverrides) {
|
|
61
|
+
if (requestParameters['vendor'] == null) {
|
|
62
|
+
throw new runtime.RequiredError('vendor', 'Required parameter "vendor" was null or undefined when calling connectIntegrationsCdp().');
|
|
63
|
+
}
|
|
64
|
+
if (requestParameters['connectCdpRequest'] == null) {
|
|
65
|
+
throw new runtime.RequiredError('connectCdpRequest', 'Required parameter "connectCdpRequest" was null or undefined when calling connectIntegrationsCdp().');
|
|
66
|
+
}
|
|
67
|
+
const queryParameters = {};
|
|
68
|
+
const headerParameters = {};
|
|
69
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
70
|
+
if (requestParameters['xIdempotencyKey'] != null) {
|
|
71
|
+
headerParameters['X-Idempotency-Key'] = String(requestParameters['xIdempotencyKey']);
|
|
72
|
+
}
|
|
73
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
74
|
+
headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
|
|
75
|
+
}
|
|
76
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
77
|
+
const token = this.configuration.accessToken;
|
|
78
|
+
const tokenString = await token("BearerAuth", []);
|
|
79
|
+
if (tokenString) {
|
|
80
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
let urlPath = `/api/v1/integrations/cdp/{vendor}`;
|
|
84
|
+
urlPath = urlPath.replace(`{${"vendor"}}`, encodeURIComponent(String(requestParameters['vendor'])));
|
|
85
|
+
const response = await this.request({
|
|
86
|
+
path: urlPath,
|
|
87
|
+
method: 'POST',
|
|
88
|
+
headers: headerParameters,
|
|
89
|
+
query: queryParameters,
|
|
90
|
+
body: (0, index_1.ConnectCdpRequestToJSON)(requestParameters['connectCdpRequest']),
|
|
91
|
+
}, initOverrides);
|
|
92
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CdpVendorResponseFromJSON)(jsonValue));
|
|
93
|
+
}
|
|
94
|
+
/**
|
|
95
|
+
* Both take credentials.writeKey, copied from your source\'s settings. RudderStack additionally requires credentials.dataPlaneUrl, an absolute https:// address: it is the hostname events are sent to and there is no default, so a connection without one is refused before anything is stored. Both accept an optional credentials.sharedSecret; set the same value on the vendor\'s webhook destination and inbound deliveries are signature-verified as well as routed by the secret URL. NO VENDOR CALL IS MADE: neither platform exposes anything that validates a write key without writing a synthetic event into your own analytics stream, so the check is a local shape check and a mistyped key is discovered by the first forward, which marks the connection DEGRADED. Returns inboundUrl ONCE — paste it into the vendor\'s Webhooks destination. It is never returned again and reconnecting rotates it. Credentials are encrypted at rest and are never returned by any endpoint. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
96
|
+
* Connect Segment or RudderStack for this workspace
|
|
97
|
+
*/
|
|
98
|
+
async connectIntegrationsCdp(requestParameters, initOverrides) {
|
|
99
|
+
const response = await this.connectIntegrationsCdpRaw(requestParameters, initOverrides);
|
|
100
|
+
return await response.value();
|
|
101
|
+
}
|
|
102
|
+
/**
|
|
103
|
+
* The answer to \'my event fired in Segment, why did nothing happen here\'. Every authenticated delivery is recorded with what it did: CONTACT_UPSERTED, CONTACT_NOT_CREATED (an identify for somebody you do not hold, with identifyCreatesContacts off), TRACK_ANNOUNCED, TRACK_UNRESOLVED (the commonest by far — a CDP tracks anonymous visitors), IGNORED (a page/screen/group/alias call, or a duplicate) or UNPARSEABLE. Cursor-paginated on the CDP\'s own timestamp, default 25 and max 100. The identity the CDP named is deliberately NOT returned — it is encrypted at rest as PII; contactId answers the same question better. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
104
|
+
* What this CDP has delivered, newest first
|
|
105
|
+
*/
|
|
106
|
+
async eventsIntegrationsRaw(requestParameters, initOverrides) {
|
|
107
|
+
if (requestParameters['vendor'] == null) {
|
|
108
|
+
throw new runtime.RequiredError('vendor', 'Required parameter "vendor" was null or undefined when calling eventsIntegrations().');
|
|
109
|
+
}
|
|
110
|
+
const queryParameters = {};
|
|
111
|
+
if (requestParameters['eventName'] != null) {
|
|
112
|
+
queryParameters['eventName'] = requestParameters['eventName'];
|
|
113
|
+
}
|
|
114
|
+
if (requestParameters['cursor'] != null) {
|
|
115
|
+
queryParameters['cursor'] = requestParameters['cursor'];
|
|
116
|
+
}
|
|
117
|
+
if (requestParameters['limit'] != null) {
|
|
118
|
+
queryParameters['limit'] = requestParameters['limit'];
|
|
119
|
+
}
|
|
120
|
+
const headerParameters = {};
|
|
121
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
122
|
+
headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
|
|
123
|
+
}
|
|
124
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
125
|
+
const token = this.configuration.accessToken;
|
|
126
|
+
const tokenString = await token("BearerAuth", []);
|
|
127
|
+
if (tokenString) {
|
|
128
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
let urlPath = `/api/v1/integrations/cdp/{vendor}/events`;
|
|
132
|
+
urlPath = urlPath.replace(`{${"vendor"}}`, encodeURIComponent(String(requestParameters['vendor'])));
|
|
133
|
+
const response = await this.request({
|
|
134
|
+
path: urlPath,
|
|
135
|
+
method: 'GET',
|
|
136
|
+
headers: headerParameters,
|
|
137
|
+
query: queryParameters,
|
|
138
|
+
}, initOverrides);
|
|
139
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CursorPageCdpInboundEventResponseFromJSON)(jsonValue));
|
|
140
|
+
}
|
|
141
|
+
/**
|
|
142
|
+
* The answer to \'my event fired in Segment, why did nothing happen here\'. Every authenticated delivery is recorded with what it did: CONTACT_UPSERTED, CONTACT_NOT_CREATED (an identify for somebody you do not hold, with identifyCreatesContacts off), TRACK_ANNOUNCED, TRACK_UNRESOLVED (the commonest by far — a CDP tracks anonymous visitors), IGNORED (a page/screen/group/alias call, or a duplicate) or UNPARSEABLE. Cursor-paginated on the CDP\'s own timestamp, default 25 and max 100. The identity the CDP named is deliberately NOT returned — it is encrypted at rest as PII; contactId answers the same question better. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
143
|
+
* What this CDP has delivered, newest first
|
|
144
|
+
*/
|
|
145
|
+
async eventsIntegrations(requestParameters, initOverrides) {
|
|
146
|
+
const response = await this.eventsIntegrationsRaw(requestParameters, initOverrides);
|
|
147
|
+
return await response.value();
|
|
148
|
+
}
|
|
149
|
+
/**
|
|
150
|
+
* identifyCreatesContacts governs whether an inbound identify for somebody this workspace does not hold may create a contact; it defaults FALSE on connect, because a CDP holds every visitor your site has ever seen. Contacts created this way carry no consent on any channel — they can be segmented and reported on, and cannot be messaged. forwardEnabled and forwardedEvents govern the outbound half: send a list to narrow forwardedEvents, [\"*\"] alone to reset it to every subscribable type (the default a connection starts with), or an empty list to forward nothing. Any omitted or null field keeps its current value — forwardedEvents included, which is why the reset is an explicit value rather than null. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
151
|
+
* Change what this CDP does in each direction
|
|
152
|
+
*/
|
|
153
|
+
async updateSettingsIntegrationsCdpRaw(requestParameters, initOverrides) {
|
|
154
|
+
if (requestParameters['vendor'] == null) {
|
|
155
|
+
throw new runtime.RequiredError('vendor', 'Required parameter "vendor" was null or undefined when calling updateSettingsIntegrationsCdp().');
|
|
156
|
+
}
|
|
157
|
+
if (requestParameters['updateCdpSettingsRequest'] == null) {
|
|
158
|
+
throw new runtime.RequiredError('updateCdpSettingsRequest', 'Required parameter "updateCdpSettingsRequest" was null or undefined when calling updateSettingsIntegrationsCdp().');
|
|
159
|
+
}
|
|
160
|
+
const queryParameters = {};
|
|
161
|
+
const headerParameters = {};
|
|
162
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
163
|
+
if (requestParameters['xIdempotencyKey'] != null) {
|
|
164
|
+
headerParameters['X-Idempotency-Key'] = String(requestParameters['xIdempotencyKey']);
|
|
165
|
+
}
|
|
166
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
167
|
+
headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
|
|
168
|
+
}
|
|
169
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
170
|
+
const token = this.configuration.accessToken;
|
|
171
|
+
const tokenString = await token("BearerAuth", []);
|
|
172
|
+
if (tokenString) {
|
|
173
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
174
|
+
}
|
|
175
|
+
}
|
|
176
|
+
let urlPath = `/api/v1/integrations/cdp/{vendor}/settings`;
|
|
177
|
+
urlPath = urlPath.replace(`{${"vendor"}}`, encodeURIComponent(String(requestParameters['vendor'])));
|
|
178
|
+
const response = await this.request({
|
|
179
|
+
path: urlPath,
|
|
180
|
+
method: 'PATCH',
|
|
181
|
+
headers: headerParameters,
|
|
182
|
+
query: queryParameters,
|
|
183
|
+
body: (0, index_1.UpdateCdpSettingsRequestToJSON)(requestParameters['updateCdpSettingsRequest']),
|
|
184
|
+
}, initOverrides);
|
|
185
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CdpVendorResponseFromJSON)(jsonValue));
|
|
186
|
+
}
|
|
187
|
+
/**
|
|
188
|
+
* identifyCreatesContacts governs whether an inbound identify for somebody this workspace does not hold may create a contact; it defaults FALSE on connect, because a CDP holds every visitor your site has ever seen. Contacts created this way carry no consent on any channel — they can be segmented and reported on, and cannot be messaged. forwardEnabled and forwardedEvents govern the outbound half: send a list to narrow forwardedEvents, [\"*\"] alone to reset it to every subscribable type (the default a connection starts with), or an empty list to forward nothing. Any omitted or null field keeps its current value — forwardedEvents included, which is why the reset is an explicit value rather than null. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
189
|
+
* Change what this CDP does in each direction
|
|
190
|
+
*/
|
|
191
|
+
async updateSettingsIntegrationsCdp(requestParameters, initOverrides) {
|
|
192
|
+
const response = await this.updateSettingsIntegrationsCdpRaw(requestParameters, initOverrides);
|
|
193
|
+
return await response.value();
|
|
194
|
+
}
|
|
195
|
+
/**
|
|
196
|
+
* Status comes from the shared connection substrate, so a vendor\'s status here always matches GET /api/v1/integrations/{vendor}. lastErrorCode is the last forwarding failure and is the health signal for these vendors: neither publishes anything a probe could read, so a connection\'s health is what the last real forward did. forwardedEvents null means every subscribable type; an empty list means none. inboundUrl is always null here — it is returned by connect only. Never returns a credential. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
197
|
+
* List both customer data platforms and this workspace\'s settings for them
|
|
198
|
+
*/
|
|
199
|
+
async vendorsIntegrationsRaw(initOverrides) {
|
|
200
|
+
const queryParameters = {};
|
|
201
|
+
const headerParameters = {};
|
|
202
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
203
|
+
headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
|
|
204
|
+
}
|
|
205
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
206
|
+
const token = this.configuration.accessToken;
|
|
207
|
+
const tokenString = await token("BearerAuth", []);
|
|
208
|
+
if (tokenString) {
|
|
209
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
210
|
+
}
|
|
211
|
+
}
|
|
212
|
+
let urlPath = `/api/v1/integrations/cdp/vendors`;
|
|
213
|
+
const response = await this.request({
|
|
214
|
+
path: urlPath,
|
|
215
|
+
method: 'GET',
|
|
216
|
+
headers: headerParameters,
|
|
217
|
+
query: queryParameters,
|
|
218
|
+
}, initOverrides);
|
|
219
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.CdpVendorResponseFromJSON));
|
|
220
|
+
}
|
|
221
|
+
/**
|
|
222
|
+
* Status comes from the shared connection substrate, so a vendor\'s status here always matches GET /api/v1/integrations/{vendor}. lastErrorCode is the last forwarding failure and is the health signal for these vendors: neither publishes anything a probe could read, so a connection\'s health is what the last real forward did. forwardedEvents null means every subscribable type; an empty list means none. inboundUrl is always null here — it is returned by connect only. Never returns a credential. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
223
|
+
* List both customer data platforms and this workspace\'s settings for them
|
|
224
|
+
*/
|
|
225
|
+
async vendorsIntegrations(initOverrides) {
|
|
226
|
+
const response = await this.vendorsIntegrationsRaw(initOverrides);
|
|
227
|
+
return await response.value();
|
|
228
|
+
}
|
|
229
|
+
}
|
|
230
|
+
exports.CdpApi = CdpApi;
|
|
@@ -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 ReceiveWebhooksCdpRequest {
|
|
14
|
+
vendor: string;
|
|
15
|
+
token: string;
|
|
16
|
+
xIdempotencyKey?: string;
|
|
17
|
+
body?: string;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* CdpWebhookApi - interface
|
|
21
|
+
*
|
|
22
|
+
* @export
|
|
23
|
+
* @interface CdpWebhookApiInterface
|
|
24
|
+
*/
|
|
25
|
+
export interface CdpWebhookApiInterface {
|
|
26
|
+
/**
|
|
27
|
+
* Where a Segment-spec identify or track arrives. Point your vendor\'s generic Webhooks destination at the URL returned once by POST /api/v1/integrations/cdp/{vendor}. Authenticated by the unguessable path token plus, when you configured a shared secret, an HMAC-SHA1 signature over the raw body on X-Signature — never by a bearer token. Answers 401 to a delivery that does not authenticate and 200 to everything else, including payloads we cannot parse and people this workspace does not hold: a CDP disables a destination that answers non-2xx. Idempotent — a replayed delivery is recognised by its own messageId and changes nothing. An identify fills in or (only if you turned that on) creates a contact; a track enrols a matched contact into automations waiting on CDP_EVENT. Nothing here can grant messaging consent on any channel. page, screen, group and alias calls are accepted and ignored. Webhook ingest < 1s.
|
|
28
|
+
* @summary Customer data platform webhook (Segment, RudderStack)
|
|
29
|
+
* @param {string} vendor
|
|
30
|
+
* @param {string} token
|
|
31
|
+
* @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.
|
|
32
|
+
* @param {string} [body]
|
|
33
|
+
* @param {*} [options] Override http request option.
|
|
34
|
+
* @throws {RequiredError}
|
|
35
|
+
* @memberof CdpWebhookApiInterface
|
|
36
|
+
*/
|
|
37
|
+
receiveWebhooksCdpRaw(requestParameters: ReceiveWebhooksCdpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
38
|
+
/**
|
|
39
|
+
* Where a Segment-spec identify or track arrives. Point your vendor\'s generic Webhooks destination at the URL returned once by POST /api/v1/integrations/cdp/{vendor}. Authenticated by the unguessable path token plus, when you configured a shared secret, an HMAC-SHA1 signature over the raw body on X-Signature — never by a bearer token. Answers 401 to a delivery that does not authenticate and 200 to everything else, including payloads we cannot parse and people this workspace does not hold: a CDP disables a destination that answers non-2xx. Idempotent — a replayed delivery is recognised by its own messageId and changes nothing. An identify fills in or (only if you turned that on) creates a contact; a track enrols a matched contact into automations waiting on CDP_EVENT. Nothing here can grant messaging consent on any channel. page, screen, group and alias calls are accepted and ignored. Webhook ingest < 1s.
|
|
40
|
+
* Customer data platform webhook (Segment, RudderStack)
|
|
41
|
+
*/
|
|
42
|
+
receiveWebhooksCdp(requestParameters: ReceiveWebhooksCdpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
*
|
|
46
|
+
*/
|
|
47
|
+
export declare class CdpWebhookApi extends runtime.BaseAPI implements CdpWebhookApiInterface {
|
|
48
|
+
/**
|
|
49
|
+
* Where a Segment-spec identify or track arrives. Point your vendor\'s generic Webhooks destination at the URL returned once by POST /api/v1/integrations/cdp/{vendor}. Authenticated by the unguessable path token plus, when you configured a shared secret, an HMAC-SHA1 signature over the raw body on X-Signature — never by a bearer token. Answers 401 to a delivery that does not authenticate and 200 to everything else, including payloads we cannot parse and people this workspace does not hold: a CDP disables a destination that answers non-2xx. Idempotent — a replayed delivery is recognised by its own messageId and changes nothing. An identify fills in or (only if you turned that on) creates a contact; a track enrols a matched contact into automations waiting on CDP_EVENT. Nothing here can grant messaging consent on any channel. page, screen, group and alias calls are accepted and ignored. Webhook ingest < 1s.
|
|
50
|
+
* Customer data platform webhook (Segment, RudderStack)
|
|
51
|
+
*/
|
|
52
|
+
receiveWebhooksCdpRaw(requestParameters: ReceiveWebhooksCdpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
53
|
+
/**
|
|
54
|
+
* Where a Segment-spec identify or track arrives. Point your vendor\'s generic Webhooks destination at the URL returned once by POST /api/v1/integrations/cdp/{vendor}. Authenticated by the unguessable path token plus, when you configured a shared secret, an HMAC-SHA1 signature over the raw body on X-Signature — never by a bearer token. Answers 401 to a delivery that does not authenticate and 200 to everything else, including payloads we cannot parse and people this workspace does not hold: a CDP disables a destination that answers non-2xx. Idempotent — a replayed delivery is recognised by its own messageId and changes nothing. An identify fills in or (only if you turned that on) creates a contact; a track enrols a matched contact into automations waiting on CDP_EVENT. Nothing here can grant messaging consent on any channel. page, screen, group and alias calls are accepted and ignored. Webhook ingest < 1s.
|
|
55
|
+
* Customer data platform webhook (Segment, RudderStack)
|
|
56
|
+
*/
|
|
57
|
+
receiveWebhooksCdp(requestParameters: ReceiveWebhooksCdpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
58
|
+
}
|
|
@@ -0,0 +1,102 @@
|
|
|
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.CdpWebhookApi = void 0;
|
|
50
|
+
const runtime = __importStar(require("../runtime"));
|
|
51
|
+
/**
|
|
52
|
+
*
|
|
53
|
+
*/
|
|
54
|
+
class CdpWebhookApi extends runtime.BaseAPI {
|
|
55
|
+
/**
|
|
56
|
+
* Where a Segment-spec identify or track arrives. Point your vendor\'s generic Webhooks destination at the URL returned once by POST /api/v1/integrations/cdp/{vendor}. Authenticated by the unguessable path token plus, when you configured a shared secret, an HMAC-SHA1 signature over the raw body on X-Signature — never by a bearer token. Answers 401 to a delivery that does not authenticate and 200 to everything else, including payloads we cannot parse and people this workspace does not hold: a CDP disables a destination that answers non-2xx. Idempotent — a replayed delivery is recognised by its own messageId and changes nothing. An identify fills in or (only if you turned that on) creates a contact; a track enrols a matched contact into automations waiting on CDP_EVENT. Nothing here can grant messaging consent on any channel. page, screen, group and alias calls are accepted and ignored. Webhook ingest < 1s.
|
|
57
|
+
* Customer data platform webhook (Segment, RudderStack)
|
|
58
|
+
*/
|
|
59
|
+
async receiveWebhooksCdpRaw(requestParameters, initOverrides) {
|
|
60
|
+
if (requestParameters['vendor'] == null) {
|
|
61
|
+
throw new runtime.RequiredError('vendor', 'Required parameter "vendor" was null or undefined when calling receiveWebhooksCdp().');
|
|
62
|
+
}
|
|
63
|
+
if (requestParameters['token'] == null) {
|
|
64
|
+
throw new runtime.RequiredError('token', 'Required parameter "token" was null or undefined when calling receiveWebhooksCdp().');
|
|
65
|
+
}
|
|
66
|
+
const queryParameters = {};
|
|
67
|
+
const headerParameters = {};
|
|
68
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
69
|
+
if (requestParameters['xIdempotencyKey'] != null) {
|
|
70
|
+
headerParameters['X-Idempotency-Key'] = String(requestParameters['xIdempotencyKey']);
|
|
71
|
+
}
|
|
72
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
73
|
+
headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
|
|
74
|
+
}
|
|
75
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
76
|
+
const token = this.configuration.accessToken;
|
|
77
|
+
const tokenString = await token("BearerAuth", []);
|
|
78
|
+
if (tokenString) {
|
|
79
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
let urlPath = `/webhooks/cdp/{vendor}/{token}`;
|
|
83
|
+
urlPath = urlPath.replace(`{${"vendor"}}`, encodeURIComponent(String(requestParameters['vendor'])));
|
|
84
|
+
urlPath = urlPath.replace(`{${"token"}}`, encodeURIComponent(String(requestParameters['token'])));
|
|
85
|
+
const response = await this.request({
|
|
86
|
+
path: urlPath,
|
|
87
|
+
method: 'POST',
|
|
88
|
+
headers: headerParameters,
|
|
89
|
+
query: queryParameters,
|
|
90
|
+
body: requestParameters['body'],
|
|
91
|
+
}, initOverrides);
|
|
92
|
+
return new runtime.VoidApiResponse(response);
|
|
93
|
+
}
|
|
94
|
+
/**
|
|
95
|
+
* Where a Segment-spec identify or track arrives. Point your vendor\'s generic Webhooks destination at the URL returned once by POST /api/v1/integrations/cdp/{vendor}. Authenticated by the unguessable path token plus, when you configured a shared secret, an HMAC-SHA1 signature over the raw body on X-Signature — never by a bearer token. Answers 401 to a delivery that does not authenticate and 200 to everything else, including payloads we cannot parse and people this workspace does not hold: a CDP disables a destination that answers non-2xx. Idempotent — a replayed delivery is recognised by its own messageId and changes nothing. An identify fills in or (only if you turned that on) creates a contact; a track enrols a matched contact into automations waiting on CDP_EVENT. Nothing here can grant messaging consent on any channel. page, screen, group and alias calls are accepted and ignored. Webhook ingest < 1s.
|
|
96
|
+
* Customer data platform webhook (Segment, RudderStack)
|
|
97
|
+
*/
|
|
98
|
+
async receiveWebhooksCdp(requestParameters, initOverrides) {
|
|
99
|
+
await this.receiveWebhooksCdpRaw(requestParameters, initOverrides);
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
exports.CdpWebhookApi = CdpWebhookApi;
|