@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,200 @@
|
|
|
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 { ConnectHelpdeskRequest, CreateTicketRequest, HelpdeskTicketResponse, HelpdeskVendorResponse, PageResponseHelpdeskTicketResponse, Pageable, UpdateHelpdeskSettingsRequest } from '../models/index';
|
|
14
|
+
export interface ConnectIntegrationsHelpdeskRequest {
|
|
15
|
+
vendor: string;
|
|
16
|
+
connectHelpdeskRequest: ConnectHelpdeskRequest;
|
|
17
|
+
xIdempotencyKey?: string;
|
|
18
|
+
}
|
|
19
|
+
export interface CreateTicketOperationRequest {
|
|
20
|
+
vendor: string;
|
|
21
|
+
createTicketRequest: CreateTicketRequest;
|
|
22
|
+
xIdempotencyKey?: string;
|
|
23
|
+
}
|
|
24
|
+
export interface SyncIntegrationsRequest {
|
|
25
|
+
vendor: string;
|
|
26
|
+
xIdempotencyKey?: string;
|
|
27
|
+
}
|
|
28
|
+
export interface TicketsRequest {
|
|
29
|
+
vendor: string;
|
|
30
|
+
pageable: Pageable;
|
|
31
|
+
}
|
|
32
|
+
export interface UpdateSettingsIntegrationsHelpdeskRequest {
|
|
33
|
+
vendor: string;
|
|
34
|
+
updateHelpdeskSettingsRequest: UpdateHelpdeskSettingsRequest;
|
|
35
|
+
xIdempotencyKey?: string;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* HelpdeskApi - interface
|
|
39
|
+
*
|
|
40
|
+
* @export
|
|
41
|
+
* @interface HelpdeskApiInterface
|
|
42
|
+
*/
|
|
43
|
+
export interface HelpdeskApiInterface {
|
|
44
|
+
/**
|
|
45
|
+
* Each vendor takes the credential its own account issues, as a credentials map, and it is verified before it is stored. Zendesk needs subdomain + email + apiToken, where the subdomain is the first label alone (acme, never https://acme.zendesk.com — the subdomain IS the hostname, so a URL is refused before any call is made); Freshdesk needs domain + apiKey and accepts either acme or acme.freshdesk.com; Intercom needs accessToken on its own, without a Bearer prefix. Credentials are encrypted at rest and are never returned by any endpoint. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
46
|
+
* @summary Connect Zendesk, Freshdesk or Intercom for this tenant
|
|
47
|
+
* @param {string} vendor
|
|
48
|
+
* @param {ConnectHelpdeskRequest} connectHelpdeskRequest
|
|
49
|
+
* @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.
|
|
50
|
+
* @param {*} [options] Override http request option.
|
|
51
|
+
* @throws {RequiredError}
|
|
52
|
+
* @memberof HelpdeskApiInterface
|
|
53
|
+
*/
|
|
54
|
+
connectIntegrationsHelpdeskRaw(requestParameters: ConnectIntegrationsHelpdeskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HelpdeskVendorResponse>>;
|
|
55
|
+
/**
|
|
56
|
+
* Each vendor takes the credential its own account issues, as a credentials map, and it is verified before it is stored. Zendesk needs subdomain + email + apiToken, where the subdomain is the first label alone (acme, never https://acme.zendesk.com — the subdomain IS the hostname, so a URL is refused before any call is made); Freshdesk needs domain + apiKey and accepts either acme or acme.freshdesk.com; Intercom needs accessToken on its own, without a Bearer prefix. Credentials are encrypted at rest and are never returned by any endpoint. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
57
|
+
* Connect Zendesk, Freshdesk or Intercom for this tenant
|
|
58
|
+
*/
|
|
59
|
+
connectIntegrationsHelpdesk(requestParameters: ConnectIntegrationsHelpdeskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HelpdeskVendorResponse>;
|
|
60
|
+
/**
|
|
61
|
+
* The conversation is the only input: the subject and the description are rendered from the thread itself, so the ticket a support agent reads and the thread an inbox agent reads cannot disagree. The requester is the conversation\'s own email or phone — a thread carrying neither is refused with HELPDESK_REQUESTER_UNIDENTIFIED rather than filed against nobody. One ticket per conversation per vendor: a second request is refused rather than duplicating a case in somebody\'s queue. Works whether or not autoCreateEnabled is set — that setting governs only what a run does by itself. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
62
|
+
* @summary Raise a ticket in this helpdesk from one conversation
|
|
63
|
+
* @param {string} vendor
|
|
64
|
+
* @param {CreateTicketRequest} createTicketRequest
|
|
65
|
+
* @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with `X-Idempotent-Replay` set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
|
|
66
|
+
* @param {*} [options] Override http request option.
|
|
67
|
+
* @throws {RequiredError}
|
|
68
|
+
* @memberof HelpdeskApiInterface
|
|
69
|
+
*/
|
|
70
|
+
createTicketRaw(requestParameters: CreateTicketOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HelpdeskTicketResponse>>;
|
|
71
|
+
/**
|
|
72
|
+
* The conversation is the only input: the subject and the description are rendered from the thread itself, so the ticket a support agent reads and the thread an inbox agent reads cannot disagree. The requester is the conversation\'s own email or phone — a thread carrying neither is refused with HELPDESK_REQUESTER_UNIDENTIFIED rather than filed against nobody. One ticket per conversation per vendor: a second request is refused rather than duplicating a case in somebody\'s queue. Works whether or not autoCreateEnabled is set — that setting governs only what a run does by itself. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
73
|
+
* Raise a ticket in this helpdesk from one conversation
|
|
74
|
+
*/
|
|
75
|
+
createTicket(requestParameters: CreateTicketOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HelpdeskTicketResponse>;
|
|
76
|
+
/**
|
|
77
|
+
* Two phases. It raises tickets for conversations nobody has answered (only when autoCreateEnabled, and capped per run), then sweeps the vendor for ticket changes since the last watermark and closes the conversations whose tickets were resolved (only when applyStatusBack). The phases fail independently: a rate limit while filing tickets does not stop resolutions arriving, and the run reports PARTIAL. A refused credential reports FAILED however many tickets got through first, because no retry fixes it. A run with nothing to do is a SUCCEEDED with zero counters. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
78
|
+
* @summary Run this tenant\'s helpdesk sync now
|
|
79
|
+
* @param {string} vendor
|
|
80
|
+
* @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.
|
|
81
|
+
* @param {*} [options] Override http request option.
|
|
82
|
+
* @throws {RequiredError}
|
|
83
|
+
* @memberof HelpdeskApiInterface
|
|
84
|
+
*/
|
|
85
|
+
syncIntegrationsRaw(requestParameters: SyncIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HelpdeskVendorResponse>>;
|
|
86
|
+
/**
|
|
87
|
+
* Two phases. It raises tickets for conversations nobody has answered (only when autoCreateEnabled, and capped per run), then sweeps the vendor for ticket changes since the last watermark and closes the conversations whose tickets were resolved (only when applyStatusBack). The phases fail independently: a rate limit while filing tickets does not stop resolutions arriving, and the run reports PARTIAL. A refused credential reports FAILED however many tickets got through first, because no retry fixes it. A run with nothing to do is a SUCCEEDED with zero counters. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
88
|
+
* Run this tenant\'s helpdesk sync now
|
|
89
|
+
*/
|
|
90
|
+
syncIntegrations(requestParameters: SyncIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HelpdeskVendorResponse>;
|
|
91
|
+
/**
|
|
92
|
+
* Newest first, paginated (default 20, max 100). Rows carry both the normalised status and the vendor\'s own raw value, so somebody diagnosing a mapping can see what the vendor actually said rather than what we made of it. appliedStatus is what this integration last wrote onto the conversation and differs from status exactly when applyStatusBack is off — it is the field that explains a solved ticket whose conversation is still open. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
93
|
+
* @summary List the tickets this tenant has raised in one helpdesk
|
|
94
|
+
* @param {string} vendor
|
|
95
|
+
* @param {Pageable} pageable
|
|
96
|
+
* @param {*} [options] Override http request option.
|
|
97
|
+
* @throws {RequiredError}
|
|
98
|
+
* @memberof HelpdeskApiInterface
|
|
99
|
+
*/
|
|
100
|
+
ticketsRaw(requestParameters: TicketsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PageResponseHelpdeskTicketResponse>>;
|
|
101
|
+
/**
|
|
102
|
+
* Newest first, paginated (default 20, max 100). Rows carry both the normalised status and the vendor\'s own raw value, so somebody diagnosing a mapping can see what the vendor actually said rather than what we made of it. appliedStatus is what this integration last wrote onto the conversation and differs from status exactly when applyStatusBack is off — it is the field that explains a solved ticket whose conversation is still open. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
103
|
+
* List the tickets this tenant has raised in one helpdesk
|
|
104
|
+
*/
|
|
105
|
+
tickets(requestParameters: TicketsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PageResponseHelpdeskTicketResponse>;
|
|
106
|
+
/**
|
|
107
|
+
* A genuine partial update: send only the fields to change, and a field left out is left alone. autoCreateEnabled defaults FALSE and must be asked for — it raises tickets in the customer\'s own helpdesk with nobody clicking anything, for conversations that have gone unanswered, capped per run so a busy inbox cannot wake a support team to a hundred tickets at once. applyStatusBack defaults TRUE and is the half that closes an Augstash conversation when its ticket is resolved; turning it off leaves tickets tracked but conversations untouched. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
108
|
+
* @summary Change how this tenant\'s helpdesk integration behaves
|
|
109
|
+
* @param {string} vendor
|
|
110
|
+
* @param {UpdateHelpdeskSettingsRequest} updateHelpdeskSettingsRequest
|
|
111
|
+
* @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.
|
|
112
|
+
* @param {*} [options] Override http request option.
|
|
113
|
+
* @throws {RequiredError}
|
|
114
|
+
* @memberof HelpdeskApiInterface
|
|
115
|
+
*/
|
|
116
|
+
updateSettingsIntegrationsHelpdeskRaw(requestParameters: UpdateSettingsIntegrationsHelpdeskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HelpdeskVendorResponse>>;
|
|
117
|
+
/**
|
|
118
|
+
* A genuine partial update: send only the fields to change, and a field left out is left alone. autoCreateEnabled defaults FALSE and must be asked for — it raises tickets in the customer\'s own helpdesk with nobody clicking anything, for conversations that have gone unanswered, capped per run so a busy inbox cannot wake a support team to a hundred tickets at once. applyStatusBack defaults TRUE and is the half that closes an Augstash conversation when its ticket is resolved; turning it off leaves tickets tracked but conversations untouched. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
119
|
+
* Change how this tenant\'s helpdesk integration behaves
|
|
120
|
+
*/
|
|
121
|
+
updateSettingsIntegrationsHelpdesk(requestParameters: UpdateSettingsIntegrationsHelpdeskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HelpdeskVendorResponse>;
|
|
122
|
+
/**
|
|
123
|
+
* Health comes from the shared connection substrate, so a vendor\'s status here always matches GET /api/v1/integrations/{vendor}. The counters are from the last run and are zero before the first one: ticketsCreated is what was filed into the customer\'s own helpdesk, statusesApplied is how many conversations a resolution actually moved — not how many statuses were read, so a quiet sweep honestly reports zero. statusWatermark is how far the sweep has read, which is the only field that answers why a ticket resolved upstream has not closed its conversation yet. Never returns a credential. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
124
|
+
* @summary List the three helpdesks and what this tenant\'s last run did
|
|
125
|
+
* @param {*} [options] Override http request option.
|
|
126
|
+
* @throws {RequiredError}
|
|
127
|
+
* @memberof HelpdeskApiInterface
|
|
128
|
+
*/
|
|
129
|
+
vendorsIntegrationsHelpdeskRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<HelpdeskVendorResponse>>>;
|
|
130
|
+
/**
|
|
131
|
+
* Health comes from the shared connection substrate, so a vendor\'s status here always matches GET /api/v1/integrations/{vendor}. The counters are from the last run and are zero before the first one: ticketsCreated is what was filed into the customer\'s own helpdesk, statusesApplied is how many conversations a resolution actually moved — not how many statuses were read, so a quiet sweep honestly reports zero. statusWatermark is how far the sweep has read, which is the only field that answers why a ticket resolved upstream has not closed its conversation yet. Never returns a credential. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
132
|
+
* List the three helpdesks and what this tenant\'s last run did
|
|
133
|
+
*/
|
|
134
|
+
vendorsIntegrationsHelpdesk(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<HelpdeskVendorResponse>>;
|
|
135
|
+
}
|
|
136
|
+
/**
|
|
137
|
+
*
|
|
138
|
+
*/
|
|
139
|
+
export declare class HelpdeskApi extends runtime.BaseAPI implements HelpdeskApiInterface {
|
|
140
|
+
/**
|
|
141
|
+
* Each vendor takes the credential its own account issues, as a credentials map, and it is verified before it is stored. Zendesk needs subdomain + email + apiToken, where the subdomain is the first label alone (acme, never https://acme.zendesk.com — the subdomain IS the hostname, so a URL is refused before any call is made); Freshdesk needs domain + apiKey and accepts either acme or acme.freshdesk.com; Intercom needs accessToken on its own, without a Bearer prefix. Credentials are encrypted at rest and are never returned by any endpoint. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
142
|
+
* Connect Zendesk, Freshdesk or Intercom for this tenant
|
|
143
|
+
*/
|
|
144
|
+
connectIntegrationsHelpdeskRaw(requestParameters: ConnectIntegrationsHelpdeskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HelpdeskVendorResponse>>;
|
|
145
|
+
/**
|
|
146
|
+
* Each vendor takes the credential its own account issues, as a credentials map, and it is verified before it is stored. Zendesk needs subdomain + email + apiToken, where the subdomain is the first label alone (acme, never https://acme.zendesk.com — the subdomain IS the hostname, so a URL is refused before any call is made); Freshdesk needs domain + apiKey and accepts either acme or acme.freshdesk.com; Intercom needs accessToken on its own, without a Bearer prefix. Credentials are encrypted at rest and are never returned by any endpoint. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
147
|
+
* Connect Zendesk, Freshdesk or Intercom for this tenant
|
|
148
|
+
*/
|
|
149
|
+
connectIntegrationsHelpdesk(requestParameters: ConnectIntegrationsHelpdeskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HelpdeskVendorResponse>;
|
|
150
|
+
/**
|
|
151
|
+
* The conversation is the only input: the subject and the description are rendered from the thread itself, so the ticket a support agent reads and the thread an inbox agent reads cannot disagree. The requester is the conversation\'s own email or phone — a thread carrying neither is refused with HELPDESK_REQUESTER_UNIDENTIFIED rather than filed against nobody. One ticket per conversation per vendor: a second request is refused rather than duplicating a case in somebody\'s queue. Works whether or not autoCreateEnabled is set — that setting governs only what a run does by itself. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
152
|
+
* Raise a ticket in this helpdesk from one conversation
|
|
153
|
+
*/
|
|
154
|
+
createTicketRaw(requestParameters: CreateTicketOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HelpdeskTicketResponse>>;
|
|
155
|
+
/**
|
|
156
|
+
* The conversation is the only input: the subject and the description are rendered from the thread itself, so the ticket a support agent reads and the thread an inbox agent reads cannot disagree. The requester is the conversation\'s own email or phone — a thread carrying neither is refused with HELPDESK_REQUESTER_UNIDENTIFIED rather than filed against nobody. One ticket per conversation per vendor: a second request is refused rather than duplicating a case in somebody\'s queue. Works whether or not autoCreateEnabled is set — that setting governs only what a run does by itself. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
157
|
+
* Raise a ticket in this helpdesk from one conversation
|
|
158
|
+
*/
|
|
159
|
+
createTicket(requestParameters: CreateTicketOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HelpdeskTicketResponse>;
|
|
160
|
+
/**
|
|
161
|
+
* Two phases. It raises tickets for conversations nobody has answered (only when autoCreateEnabled, and capped per run), then sweeps the vendor for ticket changes since the last watermark and closes the conversations whose tickets were resolved (only when applyStatusBack). The phases fail independently: a rate limit while filing tickets does not stop resolutions arriving, and the run reports PARTIAL. A refused credential reports FAILED however many tickets got through first, because no retry fixes it. A run with nothing to do is a SUCCEEDED with zero counters. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
162
|
+
* Run this tenant\'s helpdesk sync now
|
|
163
|
+
*/
|
|
164
|
+
syncIntegrationsRaw(requestParameters: SyncIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HelpdeskVendorResponse>>;
|
|
165
|
+
/**
|
|
166
|
+
* Two phases. It raises tickets for conversations nobody has answered (only when autoCreateEnabled, and capped per run), then sweeps the vendor for ticket changes since the last watermark and closes the conversations whose tickets were resolved (only when applyStatusBack). The phases fail independently: a rate limit while filing tickets does not stop resolutions arriving, and the run reports PARTIAL. A refused credential reports FAILED however many tickets got through first, because no retry fixes it. A run with nothing to do is a SUCCEEDED with zero counters. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
167
|
+
* Run this tenant\'s helpdesk sync now
|
|
168
|
+
*/
|
|
169
|
+
syncIntegrations(requestParameters: SyncIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HelpdeskVendorResponse>;
|
|
170
|
+
/**
|
|
171
|
+
* Newest first, paginated (default 20, max 100). Rows carry both the normalised status and the vendor\'s own raw value, so somebody diagnosing a mapping can see what the vendor actually said rather than what we made of it. appliedStatus is what this integration last wrote onto the conversation and differs from status exactly when applyStatusBack is off — it is the field that explains a solved ticket whose conversation is still open. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
172
|
+
* List the tickets this tenant has raised in one helpdesk
|
|
173
|
+
*/
|
|
174
|
+
ticketsRaw(requestParameters: TicketsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PageResponseHelpdeskTicketResponse>>;
|
|
175
|
+
/**
|
|
176
|
+
* Newest first, paginated (default 20, max 100). Rows carry both the normalised status and the vendor\'s own raw value, so somebody diagnosing a mapping can see what the vendor actually said rather than what we made of it. appliedStatus is what this integration last wrote onto the conversation and differs from status exactly when applyStatusBack is off — it is the field that explains a solved ticket whose conversation is still open. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
177
|
+
* List the tickets this tenant has raised in one helpdesk
|
|
178
|
+
*/
|
|
179
|
+
tickets(requestParameters: TicketsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PageResponseHelpdeskTicketResponse>;
|
|
180
|
+
/**
|
|
181
|
+
* A genuine partial update: send only the fields to change, and a field left out is left alone. autoCreateEnabled defaults FALSE and must be asked for — it raises tickets in the customer\'s own helpdesk with nobody clicking anything, for conversations that have gone unanswered, capped per run so a busy inbox cannot wake a support team to a hundred tickets at once. applyStatusBack defaults TRUE and is the half that closes an Augstash conversation when its ticket is resolved; turning it off leaves tickets tracked but conversations untouched. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
182
|
+
* Change how this tenant\'s helpdesk integration behaves
|
|
183
|
+
*/
|
|
184
|
+
updateSettingsIntegrationsHelpdeskRaw(requestParameters: UpdateSettingsIntegrationsHelpdeskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HelpdeskVendorResponse>>;
|
|
185
|
+
/**
|
|
186
|
+
* A genuine partial update: send only the fields to change, and a field left out is left alone. autoCreateEnabled defaults FALSE and must be asked for — it raises tickets in the customer\'s own helpdesk with nobody clicking anything, for conversations that have gone unanswered, capped per run so a busy inbox cannot wake a support team to a hundred tickets at once. applyStatusBack defaults TRUE and is the half that closes an Augstash conversation when its ticket is resolved; turning it off leaves tickets tracked but conversations untouched. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
187
|
+
* Change how this tenant\'s helpdesk integration behaves
|
|
188
|
+
*/
|
|
189
|
+
updateSettingsIntegrationsHelpdesk(requestParameters: UpdateSettingsIntegrationsHelpdeskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HelpdeskVendorResponse>;
|
|
190
|
+
/**
|
|
191
|
+
* Health comes from the shared connection substrate, so a vendor\'s status here always matches GET /api/v1/integrations/{vendor}. The counters are from the last run and are zero before the first one: ticketsCreated is what was filed into the customer\'s own helpdesk, statusesApplied is how many conversations a resolution actually moved — not how many statuses were read, so a quiet sweep honestly reports zero. statusWatermark is how far the sweep has read, which is the only field that answers why a ticket resolved upstream has not closed its conversation yet. Never returns a credential. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
192
|
+
* List the three helpdesks and what this tenant\'s last run did
|
|
193
|
+
*/
|
|
194
|
+
vendorsIntegrationsHelpdeskRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<HelpdeskVendorResponse>>>;
|
|
195
|
+
/**
|
|
196
|
+
* Health comes from the shared connection substrate, so a vendor\'s status here always matches GET /api/v1/integrations/{vendor}. The counters are from the last run and are zero before the first one: ticketsCreated is what was filed into the customer\'s own helpdesk, statusesApplied is how many conversations a resolution actually moved — not how many statuses were read, so a quiet sweep honestly reports zero. statusWatermark is how far the sweep has read, which is the only field that answers why a ticket resolved upstream has not closed its conversation yet. Never returns a credential. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
197
|
+
* List the three helpdesks and what this tenant\'s last run did
|
|
198
|
+
*/
|
|
199
|
+
vendorsIntegrationsHelpdesk(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<HelpdeskVendorResponse>>;
|
|
200
|
+
}
|
|
@@ -0,0 +1,314 @@
|
|
|
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.HelpdeskApi = void 0;
|
|
50
|
+
const runtime = __importStar(require("../runtime"));
|
|
51
|
+
const index_1 = require("../models/index");
|
|
52
|
+
/**
|
|
53
|
+
*
|
|
54
|
+
*/
|
|
55
|
+
class HelpdeskApi extends runtime.BaseAPI {
|
|
56
|
+
/**
|
|
57
|
+
* Each vendor takes the credential its own account issues, as a credentials map, and it is verified before it is stored. Zendesk needs subdomain + email + apiToken, where the subdomain is the first label alone (acme, never https://acme.zendesk.com — the subdomain IS the hostname, so a URL is refused before any call is made); Freshdesk needs domain + apiKey and accepts either acme or acme.freshdesk.com; Intercom needs accessToken on its own, without a Bearer prefix. Credentials are encrypted at rest and are never returned by any endpoint. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
58
|
+
* Connect Zendesk, Freshdesk or Intercom for this tenant
|
|
59
|
+
*/
|
|
60
|
+
async connectIntegrationsHelpdeskRaw(requestParameters, initOverrides) {
|
|
61
|
+
if (requestParameters['vendor'] == null) {
|
|
62
|
+
throw new runtime.RequiredError('vendor', 'Required parameter "vendor" was null or undefined when calling connectIntegrationsHelpdesk().');
|
|
63
|
+
}
|
|
64
|
+
if (requestParameters['connectHelpdeskRequest'] == null) {
|
|
65
|
+
throw new runtime.RequiredError('connectHelpdeskRequest', 'Required parameter "connectHelpdeskRequest" was null or undefined when calling connectIntegrationsHelpdesk().');
|
|
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/helpdesk/{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.ConnectHelpdeskRequestToJSON)(requestParameters['connectHelpdeskRequest']),
|
|
91
|
+
}, initOverrides);
|
|
92
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.HelpdeskVendorResponseFromJSON)(jsonValue));
|
|
93
|
+
}
|
|
94
|
+
/**
|
|
95
|
+
* Each vendor takes the credential its own account issues, as a credentials map, and it is verified before it is stored. Zendesk needs subdomain + email + apiToken, where the subdomain is the first label alone (acme, never https://acme.zendesk.com — the subdomain IS the hostname, so a URL is refused before any call is made); Freshdesk needs domain + apiKey and accepts either acme or acme.freshdesk.com; Intercom needs accessToken on its own, without a Bearer prefix. Credentials are encrypted at rest and are never returned by any endpoint. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
96
|
+
* Connect Zendesk, Freshdesk or Intercom for this tenant
|
|
97
|
+
*/
|
|
98
|
+
async connectIntegrationsHelpdesk(requestParameters, initOverrides) {
|
|
99
|
+
const response = await this.connectIntegrationsHelpdeskRaw(requestParameters, initOverrides);
|
|
100
|
+
return await response.value();
|
|
101
|
+
}
|
|
102
|
+
/**
|
|
103
|
+
* The conversation is the only input: the subject and the description are rendered from the thread itself, so the ticket a support agent reads and the thread an inbox agent reads cannot disagree. The requester is the conversation\'s own email or phone — a thread carrying neither is refused with HELPDESK_REQUESTER_UNIDENTIFIED rather than filed against nobody. One ticket per conversation per vendor: a second request is refused rather than duplicating a case in somebody\'s queue. Works whether or not autoCreateEnabled is set — that setting governs only what a run does by itself. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
104
|
+
* Raise a ticket in this helpdesk from one conversation
|
|
105
|
+
*/
|
|
106
|
+
async createTicketRaw(requestParameters, initOverrides) {
|
|
107
|
+
if (requestParameters['vendor'] == null) {
|
|
108
|
+
throw new runtime.RequiredError('vendor', 'Required parameter "vendor" was null or undefined when calling createTicket().');
|
|
109
|
+
}
|
|
110
|
+
if (requestParameters['createTicketRequest'] == null) {
|
|
111
|
+
throw new runtime.RequiredError('createTicketRequest', 'Required parameter "createTicketRequest" was null or undefined when calling createTicket().');
|
|
112
|
+
}
|
|
113
|
+
const queryParameters = {};
|
|
114
|
+
const headerParameters = {};
|
|
115
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
116
|
+
if (requestParameters['xIdempotencyKey'] != null) {
|
|
117
|
+
headerParameters['X-Idempotency-Key'] = String(requestParameters['xIdempotencyKey']);
|
|
118
|
+
}
|
|
119
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
120
|
+
headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
|
|
121
|
+
}
|
|
122
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
123
|
+
const token = this.configuration.accessToken;
|
|
124
|
+
const tokenString = await token("BearerAuth", []);
|
|
125
|
+
if (tokenString) {
|
|
126
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
let urlPath = `/api/v1/integrations/helpdesk/{vendor}/tickets`;
|
|
130
|
+
urlPath = urlPath.replace(`{${"vendor"}}`, encodeURIComponent(String(requestParameters['vendor'])));
|
|
131
|
+
const response = await this.request({
|
|
132
|
+
path: urlPath,
|
|
133
|
+
method: 'POST',
|
|
134
|
+
headers: headerParameters,
|
|
135
|
+
query: queryParameters,
|
|
136
|
+
body: (0, index_1.CreateTicketRequestToJSON)(requestParameters['createTicketRequest']),
|
|
137
|
+
}, initOverrides);
|
|
138
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.HelpdeskTicketResponseFromJSON)(jsonValue));
|
|
139
|
+
}
|
|
140
|
+
/**
|
|
141
|
+
* The conversation is the only input: the subject and the description are rendered from the thread itself, so the ticket a support agent reads and the thread an inbox agent reads cannot disagree. The requester is the conversation\'s own email or phone — a thread carrying neither is refused with HELPDESK_REQUESTER_UNIDENTIFIED rather than filed against nobody. One ticket per conversation per vendor: a second request is refused rather than duplicating a case in somebody\'s queue. Works whether or not autoCreateEnabled is set — that setting governs only what a run does by itself. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
142
|
+
* Raise a ticket in this helpdesk from one conversation
|
|
143
|
+
*/
|
|
144
|
+
async createTicket(requestParameters, initOverrides) {
|
|
145
|
+
const response = await this.createTicketRaw(requestParameters, initOverrides);
|
|
146
|
+
return await response.value();
|
|
147
|
+
}
|
|
148
|
+
/**
|
|
149
|
+
* Two phases. It raises tickets for conversations nobody has answered (only when autoCreateEnabled, and capped per run), then sweeps the vendor for ticket changes since the last watermark and closes the conversations whose tickets were resolved (only when applyStatusBack). The phases fail independently: a rate limit while filing tickets does not stop resolutions arriving, and the run reports PARTIAL. A refused credential reports FAILED however many tickets got through first, because no retry fixes it. A run with nothing to do is a SUCCEEDED with zero counters. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
150
|
+
* Run this tenant\'s helpdesk sync now
|
|
151
|
+
*/
|
|
152
|
+
async syncIntegrationsRaw(requestParameters, initOverrides) {
|
|
153
|
+
if (requestParameters['vendor'] == null) {
|
|
154
|
+
throw new runtime.RequiredError('vendor', 'Required parameter "vendor" was null or undefined when calling syncIntegrations().');
|
|
155
|
+
}
|
|
156
|
+
const queryParameters = {};
|
|
157
|
+
const headerParameters = {};
|
|
158
|
+
if (requestParameters['xIdempotencyKey'] != null) {
|
|
159
|
+
headerParameters['X-Idempotency-Key'] = String(requestParameters['xIdempotencyKey']);
|
|
160
|
+
}
|
|
161
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
162
|
+
headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
|
|
163
|
+
}
|
|
164
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
165
|
+
const token = this.configuration.accessToken;
|
|
166
|
+
const tokenString = await token("BearerAuth", []);
|
|
167
|
+
if (tokenString) {
|
|
168
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
169
|
+
}
|
|
170
|
+
}
|
|
171
|
+
let urlPath = `/api/v1/integrations/helpdesk/{vendor}/sync`;
|
|
172
|
+
urlPath = urlPath.replace(`{${"vendor"}}`, encodeURIComponent(String(requestParameters['vendor'])));
|
|
173
|
+
const response = await this.request({
|
|
174
|
+
path: urlPath,
|
|
175
|
+
method: 'POST',
|
|
176
|
+
headers: headerParameters,
|
|
177
|
+
query: queryParameters,
|
|
178
|
+
}, initOverrides);
|
|
179
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.HelpdeskVendorResponseFromJSON)(jsonValue));
|
|
180
|
+
}
|
|
181
|
+
/**
|
|
182
|
+
* Two phases. It raises tickets for conversations nobody has answered (only when autoCreateEnabled, and capped per run), then sweeps the vendor for ticket changes since the last watermark and closes the conversations whose tickets were resolved (only when applyStatusBack). The phases fail independently: a rate limit while filing tickets does not stop resolutions arriving, and the run reports PARTIAL. A refused credential reports FAILED however many tickets got through first, because no retry fixes it. A run with nothing to do is a SUCCEEDED with zero counters. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
|
|
183
|
+
* Run this tenant\'s helpdesk sync now
|
|
184
|
+
*/
|
|
185
|
+
async syncIntegrations(requestParameters, initOverrides) {
|
|
186
|
+
const response = await this.syncIntegrationsRaw(requestParameters, initOverrides);
|
|
187
|
+
return await response.value();
|
|
188
|
+
}
|
|
189
|
+
/**
|
|
190
|
+
* Newest first, paginated (default 20, max 100). Rows carry both the normalised status and the vendor\'s own raw value, so somebody diagnosing a mapping can see what the vendor actually said rather than what we made of it. appliedStatus is what this integration last wrote onto the conversation and differs from status exactly when applyStatusBack is off — it is the field that explains a solved ticket whose conversation is still open. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
191
|
+
* List the tickets this tenant has raised in one helpdesk
|
|
192
|
+
*/
|
|
193
|
+
async ticketsRaw(requestParameters, initOverrides) {
|
|
194
|
+
if (requestParameters['vendor'] == null) {
|
|
195
|
+
throw new runtime.RequiredError('vendor', 'Required parameter "vendor" was null or undefined when calling tickets().');
|
|
196
|
+
}
|
|
197
|
+
if (requestParameters['pageable'] == null) {
|
|
198
|
+
throw new runtime.RequiredError('pageable', 'Required parameter "pageable" was null or undefined when calling tickets().');
|
|
199
|
+
}
|
|
200
|
+
const queryParameters = {};
|
|
201
|
+
if (requestParameters['pageable'] != null) {
|
|
202
|
+
queryParameters['pageable'] = requestParameters['pageable'];
|
|
203
|
+
}
|
|
204
|
+
const headerParameters = {};
|
|
205
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
206
|
+
headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
|
|
207
|
+
}
|
|
208
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
209
|
+
const token = this.configuration.accessToken;
|
|
210
|
+
const tokenString = await token("BearerAuth", []);
|
|
211
|
+
if (tokenString) {
|
|
212
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
213
|
+
}
|
|
214
|
+
}
|
|
215
|
+
let urlPath = `/api/v1/integrations/helpdesk/{vendor}/tickets`;
|
|
216
|
+
urlPath = urlPath.replace(`{${"vendor"}}`, encodeURIComponent(String(requestParameters['vendor'])));
|
|
217
|
+
const response = await this.request({
|
|
218
|
+
path: urlPath,
|
|
219
|
+
method: 'GET',
|
|
220
|
+
headers: headerParameters,
|
|
221
|
+
query: queryParameters,
|
|
222
|
+
}, initOverrides);
|
|
223
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PageResponseHelpdeskTicketResponseFromJSON)(jsonValue));
|
|
224
|
+
}
|
|
225
|
+
/**
|
|
226
|
+
* Newest first, paginated (default 20, max 100). Rows carry both the normalised status and the vendor\'s own raw value, so somebody diagnosing a mapping can see what the vendor actually said rather than what we made of it. appliedStatus is what this integration last wrote onto the conversation and differs from status exactly when applyStatusBack is off — it is the field that explains a solved ticket whose conversation is still open. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
227
|
+
* List the tickets this tenant has raised in one helpdesk
|
|
228
|
+
*/
|
|
229
|
+
async tickets(requestParameters, initOverrides) {
|
|
230
|
+
const response = await this.ticketsRaw(requestParameters, initOverrides);
|
|
231
|
+
return await response.value();
|
|
232
|
+
}
|
|
233
|
+
/**
|
|
234
|
+
* A genuine partial update: send only the fields to change, and a field left out is left alone. autoCreateEnabled defaults FALSE and must be asked for — it raises tickets in the customer\'s own helpdesk with nobody clicking anything, for conversations that have gone unanswered, capped per run so a busy inbox cannot wake a support team to a hundred tickets at once. applyStatusBack defaults TRUE and is the half that closes an Augstash conversation when its ticket is resolved; turning it off leaves tickets tracked but conversations untouched. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
235
|
+
* Change how this tenant\'s helpdesk integration behaves
|
|
236
|
+
*/
|
|
237
|
+
async updateSettingsIntegrationsHelpdeskRaw(requestParameters, initOverrides) {
|
|
238
|
+
if (requestParameters['vendor'] == null) {
|
|
239
|
+
throw new runtime.RequiredError('vendor', 'Required parameter "vendor" was null or undefined when calling updateSettingsIntegrationsHelpdesk().');
|
|
240
|
+
}
|
|
241
|
+
if (requestParameters['updateHelpdeskSettingsRequest'] == null) {
|
|
242
|
+
throw new runtime.RequiredError('updateHelpdeskSettingsRequest', 'Required parameter "updateHelpdeskSettingsRequest" was null or undefined when calling updateSettingsIntegrationsHelpdesk().');
|
|
243
|
+
}
|
|
244
|
+
const queryParameters = {};
|
|
245
|
+
const headerParameters = {};
|
|
246
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
247
|
+
if (requestParameters['xIdempotencyKey'] != null) {
|
|
248
|
+
headerParameters['X-Idempotency-Key'] = String(requestParameters['xIdempotencyKey']);
|
|
249
|
+
}
|
|
250
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
251
|
+
headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
|
|
252
|
+
}
|
|
253
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
254
|
+
const token = this.configuration.accessToken;
|
|
255
|
+
const tokenString = await token("BearerAuth", []);
|
|
256
|
+
if (tokenString) {
|
|
257
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
258
|
+
}
|
|
259
|
+
}
|
|
260
|
+
let urlPath = `/api/v1/integrations/helpdesk/{vendor}/settings`;
|
|
261
|
+
urlPath = urlPath.replace(`{${"vendor"}}`, encodeURIComponent(String(requestParameters['vendor'])));
|
|
262
|
+
const response = await this.request({
|
|
263
|
+
path: urlPath,
|
|
264
|
+
method: 'PATCH',
|
|
265
|
+
headers: headerParameters,
|
|
266
|
+
query: queryParameters,
|
|
267
|
+
body: (0, index_1.UpdateHelpdeskSettingsRequestToJSON)(requestParameters['updateHelpdeskSettingsRequest']),
|
|
268
|
+
}, initOverrides);
|
|
269
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.HelpdeskVendorResponseFromJSON)(jsonValue));
|
|
270
|
+
}
|
|
271
|
+
/**
|
|
272
|
+
* A genuine partial update: send only the fields to change, and a field left out is left alone. autoCreateEnabled defaults FALSE and must be asked for — it raises tickets in the customer\'s own helpdesk with nobody clicking anything, for conversations that have gone unanswered, capped per run so a busy inbox cannot wake a support team to a hundred tickets at once. applyStatusBack defaults TRUE and is the half that closes an Augstash conversation when its ticket is resolved; turning it off leaves tickets tracked but conversations untouched. Writes < 500ms. Requires API-key scope: integrations:write.
|
|
273
|
+
* Change how this tenant\'s helpdesk integration behaves
|
|
274
|
+
*/
|
|
275
|
+
async updateSettingsIntegrationsHelpdesk(requestParameters, initOverrides) {
|
|
276
|
+
const response = await this.updateSettingsIntegrationsHelpdeskRaw(requestParameters, initOverrides);
|
|
277
|
+
return await response.value();
|
|
278
|
+
}
|
|
279
|
+
/**
|
|
280
|
+
* Health comes from the shared connection substrate, so a vendor\'s status here always matches GET /api/v1/integrations/{vendor}. The counters are from the last run and are zero before the first one: ticketsCreated is what was filed into the customer\'s own helpdesk, statusesApplied is how many conversations a resolution actually moved — not how many statuses were read, so a quiet sweep honestly reports zero. statusWatermark is how far the sweep has read, which is the only field that answers why a ticket resolved upstream has not closed its conversation yet. Never returns a credential. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
281
|
+
* List the three helpdesks and what this tenant\'s last run did
|
|
282
|
+
*/
|
|
283
|
+
async vendorsIntegrationsHelpdeskRaw(initOverrides) {
|
|
284
|
+
const queryParameters = {};
|
|
285
|
+
const headerParameters = {};
|
|
286
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
287
|
+
headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
|
|
288
|
+
}
|
|
289
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
290
|
+
const token = this.configuration.accessToken;
|
|
291
|
+
const tokenString = await token("BearerAuth", []);
|
|
292
|
+
if (tokenString) {
|
|
293
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
294
|
+
}
|
|
295
|
+
}
|
|
296
|
+
let urlPath = `/api/v1/integrations/helpdesk/vendors`;
|
|
297
|
+
const response = await this.request({
|
|
298
|
+
path: urlPath,
|
|
299
|
+
method: 'GET',
|
|
300
|
+
headers: headerParameters,
|
|
301
|
+
query: queryParameters,
|
|
302
|
+
}, initOverrides);
|
|
303
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.HelpdeskVendorResponseFromJSON));
|
|
304
|
+
}
|
|
305
|
+
/**
|
|
306
|
+
* Health comes from the shared connection substrate, so a vendor\'s status here always matches GET /api/v1/integrations/{vendor}. The counters are from the last run and are zero before the first one: ticketsCreated is what was filed into the customer\'s own helpdesk, statusesApplied is how many conversations a resolution actually moved — not how many statuses were read, so a quiet sweep honestly reports zero. statusWatermark is how far the sweep has read, which is the only field that answers why a ticket resolved upstream has not closed its conversation yet. Never returns a credential. Reads < 300ms. Requires API-key scope: integrations:read.
|
|
307
|
+
* List the three helpdesks and what this tenant\'s last run did
|
|
308
|
+
*/
|
|
309
|
+
async vendorsIntegrationsHelpdesk(initOverrides) {
|
|
310
|
+
const response = await this.vendorsIntegrationsHelpdeskRaw(initOverrides);
|
|
311
|
+
return await response.value();
|
|
312
|
+
}
|
|
313
|
+
}
|
|
314
|
+
exports.HelpdeskApi = HelpdeskApi;
|