hanzoai 8.5.749 → 8.5.889
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/api/account-api.d.ts +8 -8
- package/dist/api/account-api.js +8 -8
- package/dist/api/agent-api.d.ts +116 -60
- package/dist/api/agent-api.js +132 -60
- package/dist/api/ai-api.d.ts +4 -125
- package/dist/api/ai-api.js +4 -195
- package/dist/api/auto-api.d.ts +241 -46
- package/dist/api/auto-api.js +322 -49
- package/dist/api/base-api.d.ts +58 -0
- package/dist/api/base-api.js +118 -0
- package/dist/api/billing-api.d.ts +224 -81
- package/dist/api/billing-api.js +267 -100
- package/dist/api/captable-api.d.ts +124 -124
- package/dist/api/captable-api.js +124 -124
- package/dist/api/channel-api.d.ts +16 -16
- package/dist/api/channel-api.js +16 -16
- package/dist/api/commerce-api.d.ts +4 -292
- package/dist/api/commerce-api.js +4 -452
- package/dist/api/company-api.d.ts +72 -72
- package/dist/api/company-api.js +72 -72
- package/dist/api/dataroom-api.d.ts +52 -52
- package/dist/api/dataroom-api.js +52 -52
- package/dist/api/esign-api.d.ts +32 -32
- package/dist/api/esign-api.js +32 -32
- package/dist/api/event-api.d.ts +4 -4
- package/dist/api/event-api.js +4 -4
- package/dist/api/framework-api.d.ts +4 -4
- package/dist/api/framework-api.js +4 -4
- package/dist/api/gateway-api.d.ts +4 -4
- package/dist/api/gateway-api.js +4 -4
- package/dist/api/graph-api.d.ts +33 -4
- package/dist/api/graph-api.js +63 -4
- package/dist/api/iam-api.d.ts +202 -32
- package/dist/api/iam-api.js +232 -44
- package/dist/api/kms-api.d.ts +4 -4
- package/dist/api/kms-api.js +4 -4
- package/dist/api/knowledge-api.d.ts +8 -8
- package/dist/api/knowledge-api.js +8 -8
- package/dist/api/library-api.d.ts +401 -0
- package/dist/api/library-api.js +511 -0
- package/dist/api/marketing-api.d.ts +492 -44
- package/dist/api/marketing-api.js +662 -47
- package/dist/api/platform-api.d.ts +12 -12
- package/dist/api/platform-api.js +12 -12
- package/dist/api/pricing-api.d.ts +4 -75
- package/dist/api/pricing-api.js +4 -85
- package/dist/api/project-api.d.ts +16 -16
- package/dist/api/project-api.js +16 -16
- package/dist/api/s3-api.d.ts +8 -8
- package/dist/api/s3-api.js +8 -8
- package/dist/api/studio-api.d.ts +1774 -0
- package/dist/api/studio-api.js +2407 -0
- package/dist/api/translate-api.d.ts +27 -8
- package/dist/api/translate-api.js +17 -11
- package/dist/api/x402-api.d.ts +12 -12
- package/dist/api/x402-api.js +12 -12
- package/dist/api.d.ts +2 -0
- package/dist/api.js +2 -0
- package/dist/esm/api/account-api.d.ts +8 -8
- package/dist/esm/api/account-api.js +8 -8
- package/dist/esm/api/agent-api.d.ts +116 -60
- package/dist/esm/api/agent-api.js +132 -60
- package/dist/esm/api/ai-api.d.ts +4 -125
- package/dist/esm/api/ai-api.js +4 -195
- package/dist/esm/api/auto-api.d.ts +241 -46
- package/dist/esm/api/auto-api.js +322 -49
- package/dist/esm/api/base-api.d.ts +58 -0
- package/dist/esm/api/base-api.js +118 -0
- package/dist/esm/api/billing-api.d.ts +224 -81
- package/dist/esm/api/billing-api.js +267 -100
- package/dist/esm/api/captable-api.d.ts +124 -124
- package/dist/esm/api/captable-api.js +124 -124
- package/dist/esm/api/channel-api.d.ts +16 -16
- package/dist/esm/api/channel-api.js +16 -16
- package/dist/esm/api/commerce-api.d.ts +4 -292
- package/dist/esm/api/commerce-api.js +4 -452
- package/dist/esm/api/company-api.d.ts +72 -72
- package/dist/esm/api/company-api.js +72 -72
- package/dist/esm/api/dataroom-api.d.ts +52 -52
- package/dist/esm/api/dataroom-api.js +52 -52
- package/dist/esm/api/esign-api.d.ts +32 -32
- package/dist/esm/api/esign-api.js +32 -32
- package/dist/esm/api/event-api.d.ts +4 -4
- package/dist/esm/api/event-api.js +4 -4
- package/dist/esm/api/framework-api.d.ts +4 -4
- package/dist/esm/api/framework-api.js +4 -4
- package/dist/esm/api/gateway-api.d.ts +4 -4
- package/dist/esm/api/gateway-api.js +4 -4
- package/dist/esm/api/graph-api.d.ts +33 -4
- package/dist/esm/api/graph-api.js +63 -4
- package/dist/esm/api/iam-api.d.ts +202 -32
- package/dist/esm/api/iam-api.js +232 -44
- package/dist/esm/api/kms-api.d.ts +4 -4
- package/dist/esm/api/kms-api.js +4 -4
- package/dist/esm/api/knowledge-api.d.ts +8 -8
- package/dist/esm/api/knowledge-api.js +8 -8
- package/dist/esm/api/library-api.d.ts +400 -0
- package/dist/esm/api/library-api.js +501 -0
- package/dist/esm/api/marketing-api.d.ts +492 -44
- package/dist/esm/api/marketing-api.js +662 -47
- package/dist/esm/api/platform-api.d.ts +12 -12
- package/dist/esm/api/platform-api.js +12 -12
- package/dist/esm/api/pricing-api.d.ts +4 -75
- package/dist/esm/api/pricing-api.js +4 -85
- package/dist/esm/api/project-api.d.ts +16 -16
- package/dist/esm/api/project-api.js +16 -16
- package/dist/esm/api/s3-api.d.ts +8 -8
- package/dist/esm/api/s3-api.js +8 -8
- package/dist/esm/api/studio-api.d.ts +1773 -0
- package/dist/esm/api/studio-api.js +2397 -0
- package/dist/esm/api/translate-api.d.ts +27 -8
- package/dist/esm/api/translate-api.js +17 -11
- package/dist/esm/api/x402-api.d.ts +12 -12
- package/dist/esm/api/x402-api.js +12 -12
- package/dist/esm/api.d.ts +2 -0
- package/dist/esm/api.js +2 -0
- package/dist/esm/models/account-onboard-req.d.ts +1 -1
- package/dist/esm/models/account-onboard-resp.d.ts +2 -8
- package/dist/esm/models/agent-coding-ack.d.ts +24 -0
- package/dist/esm/models/agent-coding-instruction.d.ts +30 -0
- package/dist/esm/models/agent-register-req.d.ts +0 -6
- package/dist/esm/models/ai-limits.d.ts +2 -2
- package/dist/esm/models/ai-model-info.d.ts +14 -0
- package/dist/esm/models/ai-model-pricing-info.d.ts +0 -26
- package/dist/esm/models/ai-routing-proposal.d.ts +6 -0
- package/dist/esm/models/ai-routing-view.d.ts +6 -0
- package/dist/esm/models/ai-video-spec.d.ts +54 -0
- package/dist/esm/models/ai-voice-spec.d.ts +24 -0
- package/dist/esm/models/audit-wire.d.ts +6 -0
- package/dist/esm/models/auto-automation-in.d.ts +6 -0
- package/dist/esm/models/auto-automation-run.d.ts +6 -0
- package/dist/esm/models/auto-automation.d.ts +6 -0
- package/dist/esm/models/auto-job-page.d.ts +25 -0
- package/dist/esm/models/auto-job.d.ts +126 -0
- package/dist/esm/models/auto-schedule.d.ts +2 -2
- package/dist/esm/models/auto-when-in.d.ts +30 -0
- package/dist/esm/models/auto-when-out.d.ts +37 -0
- package/dist/esm/models/benchmark-claim-row.d.ts +12 -0
- package/dist/esm/models/{benchmark-published-claim.d.ts → benchmark-claim.d.ts} +23 -11
- package/dist/esm/models/benchmark-claim.js +14 -0
- package/dist/esm/models/benchmark-leader-row.d.ts +12 -0
- package/dist/esm/models/benchmark-put-claims-in.d.ts +3 -3
- package/dist/esm/models/billing-assignment.d.ts +25 -0
- package/dist/esm/models/billing-assignment.js +14 -0
- package/dist/esm/models/billing-auto-recharge.d.ts +6 -0
- package/dist/esm/models/billing-invoice-ref.d.ts +30 -0
- package/dist/esm/models/billing-invoice-ref.js +14 -0
- package/dist/esm/models/billing-resize.d.ts +31 -0
- package/dist/esm/models/billing-resize.js +14 -0
- package/dist/esm/models/billing-sale-line.d.ts +30 -0
- package/dist/esm/models/billing-sale-line.js +14 -0
- package/dist/esm/models/{billing-subscription-ref.d.ts → billing-subscription-act.d.ts} +6 -6
- package/dist/esm/models/billing-subscription-act.js +14 -0
- package/dist/esm/models/billing-subscription-line.d.ts +54 -0
- package/dist/esm/models/billing-subscription-line.js +14 -0
- package/dist/esm/models/billing-subscription-plan.d.ts +6 -0
- package/dist/esm/models/billing-subscription-seat.d.ts +30 -0
- package/dist/esm/models/billing-subscription-seat.js +14 -0
- package/dist/esm/models/billing-subscription.d.ts +26 -0
- package/dist/esm/models/brief.d.ts +68 -0
- package/dist/esm/models/brief.js +14 -0
- package/dist/esm/models/capture-event.d.ts +6 -0
- package/dist/esm/models/capture-result.d.ts +6 -0
- package/dist/esm/models/chat-turn.d.ts +48 -0
- package/dist/esm/models/chat-turn.js +14 -0
- package/dist/esm/models/compliance-wire.d.ts +6 -0
- package/dist/esm/models/compute-byo-worker.d.ts +13 -0
- package/dist/esm/models/compute-lane-model.d.ts +36 -0
- package/dist/esm/models/compute-lane-model.js +14 -0
- package/dist/esm/models/decision.d.ts +2 -8
- package/dist/esm/models/delivery.d.ts +50 -0
- package/dist/esm/models/delivery.js +14 -0
- package/dist/esm/models/flag-platform-out.d.ts +1 -1
- package/dist/esm/models/framework-install.d.ts +6 -0
- package/dist/esm/models/gateway-policy.d.ts +8 -2
- package/dist/esm/models/graph-qlerror.d.ts +2 -2
- package/dist/esm/models/index.d.ts +77 -8
- package/dist/esm/models/index.js +77 -8
- package/dist/esm/models/kms-kms-health.d.ts +7 -1
- package/dist/esm/models/library-item-page.d.ts +31 -0
- package/dist/esm/models/library-item-page.js +14 -0
- package/dist/esm/models/library-item-patch.d.ts +42 -0
- package/dist/esm/models/library-item-patch.js +14 -0
- package/dist/esm/models/library-keep-in.d.ts +102 -0
- package/dist/esm/models/library-keep-in.js +14 -0
- package/dist/esm/models/library-library-item.d.ts +156 -0
- package/dist/esm/models/library-library-item.js +14 -0
- package/dist/{models/pricing-price.d.ts → esm/models/marketing-address.d.ts} +20 -14
- package/dist/esm/models/marketing-address.js +14 -0
- package/dist/esm/models/marketing-answer.d.ts +30 -0
- package/dist/esm/models/marketing-answer.js +14 -0
- package/dist/esm/models/marketing-beta-act-in.d.ts +36 -0
- package/dist/esm/models/marketing-beta-act-in.js +14 -0
- package/dist/esm/models/marketing-beta-action.d.ts +42 -0
- package/dist/esm/models/marketing-beta-action.js +14 -0
- package/dist/esm/models/marketing-beta-answer.d.ts +36 -0
- package/dist/esm/models/marketing-beta-answer.js +14 -0
- package/dist/esm/models/marketing-beta-in.d.ts +43 -0
- package/dist/esm/models/marketing-beta-in.js +14 -0
- package/dist/esm/models/marketing-beta-request.d.ts +24 -0
- package/dist/esm/models/marketing-beta-request.js +14 -0
- package/dist/esm/models/marketing-beta.d.ts +94 -0
- package/dist/esm/models/marketing-beta.js +14 -0
- package/dist/esm/models/marketing-esign-document.d.ts +37 -0
- package/dist/esm/models/marketing-esign-document.js +14 -0
- package/dist/esm/models/marketing-esign-event.d.ts +31 -0
- package/dist/esm/models/marketing-esign-event.js +14 -0
- package/dist/esm/models/marketing-esign-recipient.d.ts +30 -0
- package/dist/esm/models/marketing-esign-recipient.js +14 -0
- package/dist/esm/models/marketing-lead-in.d.ts +94 -1
- package/dist/esm/models/marketing-lead.d.ts +13 -1
- package/dist/esm/models/{pricing-price.d.ts → marketing-mail-in.d.ts} +14 -14
- package/dist/esm/models/marketing-mail-in.js +14 -0
- package/dist/esm/models/marketing-mail-out.d.ts +30 -0
- package/dist/esm/models/marketing-mail-out.js +14 -0
- package/dist/esm/models/marketing-resume-form.d.ts +44 -0
- package/dist/esm/models/marketing-resume-form.js +14 -0
- package/dist/esm/models/marketing-resume-in.d.ts +36 -0
- package/dist/esm/models/marketing-resume-in.js +14 -0
- package/dist/esm/models/marketing-signing.d.ts +24 -0
- package/dist/esm/models/marketing-signing.js +14 -0
- package/dist/esm/models/marketing-step.d.ts +1 -1
- package/dist/esm/models/marketing-tags.d.ts +48 -0
- package/dist/esm/models/marketing-tags.js +14 -0
- package/dist/esm/models/marketing-visit.d.ts +1 -1
- package/dist/esm/models/platform-app-out.d.ts +1 -1
- package/dist/esm/models/platform-domain-view.d.ts +1 -1
- package/dist/esm/models/project-projects-project.d.ts +6 -0
- package/dist/esm/models/replay-body.d.ts +6 -0
- package/dist/esm/models/routing-version.d.ts +6 -0
- package/dist/esm/models/studio-brand-page.d.ts +31 -0
- package/dist/esm/models/studio-brand-page.js +14 -0
- package/dist/esm/models/studio-brand-patch.d.ts +50 -0
- package/dist/esm/models/studio-brand-patch.js +14 -0
- package/dist/esm/models/studio-brand-write.d.ts +44 -0
- package/dist/esm/models/studio-brand-write.js +14 -0
- package/dist/esm/models/studio-brand.d.ts +74 -0
- package/dist/esm/models/studio-brand.js +14 -0
- package/dist/esm/models/studio-document-page.d.ts +31 -0
- package/dist/esm/models/studio-document-page.js +14 -0
- package/dist/esm/models/studio-document-patch.d.ts +49 -0
- package/dist/esm/models/studio-document-patch.js +14 -0
- package/dist/esm/models/studio-document-write.d.ts +49 -0
- package/dist/esm/models/studio-document-write.js +14 -0
- package/dist/esm/models/studio-document.d.ts +79 -0
- package/dist/esm/models/studio-document.js +14 -0
- package/dist/esm/models/studio-estimate.d.ts +31 -0
- package/dist/esm/models/studio-estimate.js +14 -0
- package/dist/esm/models/studio-flow-page.d.ts +31 -0
- package/dist/esm/models/studio-flow-page.js +14 -0
- package/dist/esm/models/studio-flow-patch.d.ts +63 -0
- package/dist/esm/models/studio-flow-patch.js +14 -0
- package/dist/esm/models/studio-flow-write.d.ts +57 -0
- package/dist/esm/models/studio-flow-write.js +14 -0
- package/dist/esm/models/studio-flow.d.ts +87 -0
- package/dist/esm/models/studio-flow.js +14 -0
- package/dist/esm/models/studio-gpu-list.d.ts +25 -0
- package/dist/esm/models/studio-gpu-list.js +14 -0
- package/dist/esm/models/studio-gpu.d.ts +60 -0
- package/dist/esm/models/studio-gpu.js +14 -0
- package/dist/esm/models/studio-graph.d.ts +25 -0
- package/dist/esm/models/studio-graph.js +14 -0
- package/dist/esm/models/studio-ir.d.ts +34 -0
- package/dist/esm/models/studio-ir.js +14 -0
- package/dist/esm/models/studio-item.d.ts +138 -0
- package/dist/esm/models/studio-item.js +14 -0
- package/dist/esm/models/studio-message.d.ts +54 -0
- package/dist/esm/models/studio-message.js +14 -0
- package/dist/esm/models/studio-problem.d.ts +48 -0
- package/dist/esm/models/studio-problem.js +14 -0
- package/dist/esm/models/studio-run-create.d.ts +69 -0
- package/dist/esm/models/studio-run-create.js +14 -0
- package/dist/esm/models/studio-run-page.d.ts +31 -0
- package/dist/esm/models/studio-run-page.js +14 -0
- package/dist/esm/models/studio-run-patch.d.ts +36 -0
- package/dist/esm/models/studio-run-patch.js +14 -0
- package/dist/esm/models/studio-run.d.ts +168 -0
- package/dist/esm/models/studio-run.js +14 -0
- package/dist/esm/models/studio-spec.d.ts +50 -0
- package/dist/esm/models/studio-spec.js +14 -0
- package/dist/esm/models/studio-step-price.d.ts +36 -0
- package/dist/esm/models/studio-step-price.js +14 -0
- package/dist/esm/models/studio-step.d.ts +109 -0
- package/dist/esm/models/studio-step.js +14 -0
- package/dist/esm/models/studio-template-page.d.ts +31 -0
- package/dist/esm/models/studio-template-page.js +14 -0
- package/dist/esm/models/studio-template-patch.d.ts +63 -0
- package/dist/esm/models/studio-template-patch.js +14 -0
- package/dist/esm/models/studio-template-write.d.ts +63 -0
- package/dist/esm/models/studio-template-write.js +14 -0
- package/dist/esm/models/studio-template.d.ts +93 -0
- package/dist/esm/models/studio-template.js +14 -0
- package/dist/esm/models/studio-thread-card.d.ts +36 -0
- package/dist/esm/models/studio-thread-card.js +14 -0
- package/dist/esm/models/studio-thread-page.d.ts +31 -0
- package/dist/esm/models/studio-thread-page.js +14 -0
- package/dist/esm/models/studio-thread.d.ts +61 -0
- package/dist/esm/models/studio-thread.js +14 -0
- package/dist/esm/models/{ai-per-million.d.ts → tally.d.ts} +16 -10
- package/dist/esm/models/tally.js +14 -0
- package/dist/esm/models/translate-memory-entry.d.ts +24 -0
- package/dist/esm/models/translate-review-request.d.ts +18 -0
- package/dist/esm/models/translation.d.ts +48 -0
- package/dist/esm/models/translation.js +14 -0
- package/dist/models/account-onboard-req.d.ts +1 -1
- package/dist/models/account-onboard-resp.d.ts +2 -8
- package/dist/models/agent-coding-ack.d.ts +24 -0
- package/dist/models/agent-coding-instruction.d.ts +30 -0
- package/dist/models/agent-register-req.d.ts +0 -6
- package/dist/models/ai-limits.d.ts +2 -2
- package/dist/models/ai-model-info.d.ts +14 -0
- package/dist/models/ai-model-pricing-info.d.ts +0 -26
- package/dist/models/ai-routing-proposal.d.ts +6 -0
- package/dist/models/ai-routing-view.d.ts +6 -0
- package/dist/models/ai-video-spec.d.ts +54 -0
- package/dist/models/ai-voice-spec.d.ts +24 -0
- package/dist/models/audit-wire.d.ts +6 -0
- package/dist/models/auto-automation-in.d.ts +6 -0
- package/dist/models/auto-automation-run.d.ts +6 -0
- package/dist/models/auto-automation.d.ts +6 -0
- package/dist/models/auto-job-page.d.ts +25 -0
- package/dist/models/auto-job.d.ts +126 -0
- package/dist/models/auto-schedule.d.ts +2 -2
- package/dist/models/auto-when-in.d.ts +30 -0
- package/dist/models/auto-when-out.d.ts +37 -0
- package/dist/models/benchmark-claim-row.d.ts +12 -0
- package/dist/models/{benchmark-published-claim.d.ts → benchmark-claim.d.ts} +23 -11
- package/dist/models/benchmark-claim.js +15 -0
- package/dist/models/benchmark-leader-row.d.ts +12 -0
- package/dist/models/benchmark-put-claims-in.d.ts +3 -3
- package/dist/models/billing-assignment.d.ts +25 -0
- package/dist/models/billing-assignment.js +15 -0
- package/dist/models/billing-auto-recharge.d.ts +6 -0
- package/dist/models/billing-invoice-ref.d.ts +30 -0
- package/dist/models/billing-invoice-ref.js +15 -0
- package/dist/models/billing-resize.d.ts +31 -0
- package/dist/models/billing-resize.js +15 -0
- package/dist/models/billing-sale-line.d.ts +30 -0
- package/dist/models/billing-sale-line.js +15 -0
- package/dist/models/{billing-subscription-ref.d.ts → billing-subscription-act.d.ts} +6 -6
- package/dist/models/billing-subscription-act.js +15 -0
- package/dist/models/billing-subscription-line.d.ts +54 -0
- package/dist/models/billing-subscription-line.js +15 -0
- package/dist/models/billing-subscription-plan.d.ts +6 -0
- package/dist/models/billing-subscription-seat.d.ts +30 -0
- package/dist/models/billing-subscription-seat.js +15 -0
- package/dist/models/billing-subscription.d.ts +26 -0
- package/dist/models/brief.d.ts +68 -0
- package/dist/models/brief.js +15 -0
- package/dist/models/capture-event.d.ts +6 -0
- package/dist/models/capture-result.d.ts +6 -0
- package/dist/models/chat-turn.d.ts +48 -0
- package/dist/models/chat-turn.js +15 -0
- package/dist/models/compliance-wire.d.ts +6 -0
- package/dist/models/compute-byo-worker.d.ts +13 -0
- package/dist/models/compute-lane-model.d.ts +36 -0
- package/dist/models/compute-lane-model.js +15 -0
- package/dist/models/decision.d.ts +2 -8
- package/dist/models/delivery.d.ts +50 -0
- package/dist/models/delivery.js +15 -0
- package/dist/models/flag-platform-out.d.ts +1 -1
- package/dist/models/framework-install.d.ts +6 -0
- package/dist/models/gateway-policy.d.ts +8 -2
- package/dist/models/graph-qlerror.d.ts +2 -2
- package/dist/models/index.d.ts +77 -8
- package/dist/models/index.js +77 -8
- package/dist/models/kms-kms-health.d.ts +7 -1
- package/dist/models/library-item-page.d.ts +31 -0
- package/dist/models/library-item-page.js +15 -0
- package/dist/models/library-item-patch.d.ts +42 -0
- package/dist/models/library-item-patch.js +15 -0
- package/dist/models/library-keep-in.d.ts +102 -0
- package/dist/models/library-keep-in.js +15 -0
- package/dist/models/library-library-item.d.ts +156 -0
- package/dist/models/library-library-item.js +15 -0
- package/dist/models/marketing-address.d.ts +48 -0
- package/dist/models/marketing-address.js +15 -0
- package/dist/models/marketing-answer.d.ts +30 -0
- package/dist/models/marketing-answer.js +15 -0
- package/dist/models/marketing-beta-act-in.d.ts +36 -0
- package/dist/models/marketing-beta-act-in.js +15 -0
- package/dist/models/marketing-beta-action.d.ts +42 -0
- package/dist/models/marketing-beta-action.js +15 -0
- package/dist/models/marketing-beta-answer.d.ts +36 -0
- package/dist/models/marketing-beta-answer.js +15 -0
- package/dist/models/marketing-beta-in.d.ts +43 -0
- package/dist/models/marketing-beta-in.js +15 -0
- package/dist/models/marketing-beta-request.d.ts +24 -0
- package/dist/models/marketing-beta-request.js +15 -0
- package/dist/models/marketing-beta.d.ts +94 -0
- package/dist/models/marketing-beta.js +15 -0
- package/dist/models/marketing-esign-document.d.ts +37 -0
- package/dist/models/marketing-esign-document.js +15 -0
- package/dist/models/marketing-esign-event.d.ts +31 -0
- package/dist/models/marketing-esign-event.js +15 -0
- package/dist/models/marketing-esign-recipient.d.ts +30 -0
- package/dist/models/marketing-esign-recipient.js +15 -0
- package/dist/models/marketing-lead-in.d.ts +94 -1
- package/dist/models/marketing-lead.d.ts +13 -1
- package/dist/models/marketing-mail-in.d.ts +42 -0
- package/dist/models/marketing-mail-in.js +15 -0
- package/dist/models/marketing-mail-out.d.ts +30 -0
- package/dist/models/marketing-mail-out.js +15 -0
- package/dist/models/marketing-resume-form.d.ts +44 -0
- package/dist/models/marketing-resume-form.js +15 -0
- package/dist/models/marketing-resume-in.d.ts +36 -0
- package/dist/models/marketing-resume-in.js +15 -0
- package/dist/models/marketing-signing.d.ts +24 -0
- package/dist/models/marketing-signing.js +15 -0
- package/dist/models/marketing-step.d.ts +1 -1
- package/dist/models/marketing-tags.d.ts +48 -0
- package/dist/models/marketing-tags.js +15 -0
- package/dist/models/marketing-visit.d.ts +1 -1
- package/dist/models/platform-app-out.d.ts +1 -1
- package/dist/models/platform-domain-view.d.ts +1 -1
- package/dist/models/project-projects-project.d.ts +6 -0
- package/dist/models/replay-body.d.ts +6 -0
- package/dist/models/routing-version.d.ts +6 -0
- package/dist/models/studio-brand-page.d.ts +31 -0
- package/dist/models/studio-brand-page.js +15 -0
- package/dist/models/studio-brand-patch.d.ts +50 -0
- package/dist/models/studio-brand-patch.js +15 -0
- package/dist/models/studio-brand-write.d.ts +44 -0
- package/dist/models/studio-brand-write.js +15 -0
- package/dist/models/studio-brand.d.ts +74 -0
- package/dist/models/studio-brand.js +15 -0
- package/dist/models/studio-document-page.d.ts +31 -0
- package/dist/models/studio-document-page.js +15 -0
- package/dist/models/studio-document-patch.d.ts +49 -0
- package/dist/models/studio-document-patch.js +15 -0
- package/dist/models/studio-document-write.d.ts +49 -0
- package/dist/models/studio-document-write.js +15 -0
- package/dist/models/studio-document.d.ts +79 -0
- package/dist/models/studio-document.js +15 -0
- package/dist/models/studio-estimate.d.ts +31 -0
- package/dist/models/studio-estimate.js +15 -0
- package/dist/models/studio-flow-page.d.ts +31 -0
- package/dist/models/studio-flow-page.js +15 -0
- package/dist/models/studio-flow-patch.d.ts +63 -0
- package/dist/models/studio-flow-patch.js +15 -0
- package/dist/models/studio-flow-write.d.ts +57 -0
- package/dist/models/studio-flow-write.js +15 -0
- package/dist/models/studio-flow.d.ts +87 -0
- package/dist/models/studio-flow.js +15 -0
- package/dist/models/studio-gpu-list.d.ts +25 -0
- package/dist/models/studio-gpu-list.js +15 -0
- package/dist/models/studio-gpu.d.ts +60 -0
- package/dist/models/studio-gpu.js +15 -0
- package/dist/models/studio-graph.d.ts +25 -0
- package/dist/models/studio-graph.js +15 -0
- package/dist/models/studio-ir.d.ts +34 -0
- package/dist/models/studio-ir.js +15 -0
- package/dist/models/studio-item.d.ts +138 -0
- package/dist/models/studio-item.js +15 -0
- package/dist/models/studio-message.d.ts +54 -0
- package/dist/models/studio-message.js +15 -0
- package/dist/models/studio-problem.d.ts +48 -0
- package/dist/models/studio-problem.js +15 -0
- package/dist/models/studio-run-create.d.ts +69 -0
- package/dist/models/studio-run-create.js +15 -0
- package/dist/models/studio-run-page.d.ts +31 -0
- package/dist/models/studio-run-page.js +15 -0
- package/dist/models/studio-run-patch.d.ts +36 -0
- package/dist/models/studio-run-patch.js +15 -0
- package/dist/models/studio-run.d.ts +168 -0
- package/dist/models/studio-run.js +15 -0
- package/dist/models/studio-spec.d.ts +50 -0
- package/dist/models/studio-spec.js +15 -0
- package/dist/models/studio-step-price.d.ts +36 -0
- package/dist/models/studio-step-price.js +15 -0
- package/dist/models/studio-step.d.ts +109 -0
- package/dist/models/studio-step.js +15 -0
- package/dist/models/studio-template-page.d.ts +31 -0
- package/dist/models/studio-template-page.js +15 -0
- package/dist/models/studio-template-patch.d.ts +63 -0
- package/dist/models/studio-template-patch.js +15 -0
- package/dist/models/studio-template-write.d.ts +63 -0
- package/dist/models/studio-template-write.js +15 -0
- package/dist/models/studio-template.d.ts +93 -0
- package/dist/models/studio-template.js +15 -0
- package/dist/models/studio-thread-card.d.ts +36 -0
- package/dist/models/studio-thread-card.js +15 -0
- package/dist/models/studio-thread-page.d.ts +31 -0
- package/dist/models/studio-thread-page.js +15 -0
- package/dist/models/studio-thread.d.ts +61 -0
- package/dist/models/studio-thread.js +15 -0
- package/dist/models/{ai-per-million.d.ts → tally.d.ts} +16 -10
- package/dist/models/tally.js +15 -0
- package/dist/models/translate-memory-entry.d.ts +24 -0
- package/dist/models/translate-review-request.d.ts +18 -0
- package/dist/models/translation.d.ts +48 -0
- package/dist/models/translation.js +15 -0
- package/package.json +1 -1
- package/src/api/account-api.ts +8 -8
- package/src/api/agent-api.ts +165 -60
- package/src/api/ai-api.ts +4 -244
- package/src/api/auto-api.ts +426 -49
- package/src/api/base-api.ts +132 -0
- package/src/api/billing-api.ts +370 -107
- package/src/api/captable-api.ts +124 -124
- package/src/api/channel-api.ts +16 -16
- package/src/api/commerce-api.ts +4 -571
- package/src/api/company-api.ts +72 -72
- package/src/api/dataroom-api.ts +52 -52
- package/src/api/esign-api.ts +32 -32
- package/src/api/event-api.ts +4 -4
- package/src/api/framework-api.ts +4 -4
- package/src/api/gateway-api.ts +4 -4
- package/src/api/graph-api.ts +70 -4
- package/src/api/iam-api.ts +344 -44
- package/src/api/kms-api.ts +4 -4
- package/src/api/knowledge-api.ts +8 -8
- package/src/api/library-api.ts +727 -0
- package/src/api/marketing-api.ts +907 -51
- package/src/api/platform-api.ts +12 -12
- package/src/api/pricing-api.ts +4 -133
- package/src/api/project-api.ts +16 -16
- package/src/api/s3-api.ts +8 -8
- package/src/api/studio-api.ts +3326 -0
- package/src/api/translate-api.ts +36 -11
- package/src/api/x402-api.ts +12 -12
- package/src/api.ts +2 -0
- package/src/models/account-onboard-req.ts +1 -1
- package/src/models/account-onboard-resp.ts +2 -8
- package/src/models/agent-coding-ack.ts +30 -0
- package/src/models/agent-coding-instruction.ts +36 -0
- package/src/models/agent-register-req.ts +0 -6
- package/src/models/ai-limits.ts +2 -2
- package/src/models/ai-model-info.ts +18 -0
- package/src/models/ai-model-pricing-info.ts +0 -30
- package/src/models/ai-routing-proposal.ts +6 -0
- package/src/models/ai-routing-view.ts +6 -0
- package/src/models/ai-video-spec.ts +60 -0
- package/src/models/ai-voice-spec.ts +30 -0
- package/src/models/audit-wire.ts +6 -0
- package/src/models/auto-automation-in.ts +6 -0
- package/src/models/auto-automation-run.ts +6 -0
- package/src/models/auto-automation.ts +6 -0
- package/src/models/auto-job-page.ts +33 -0
- package/src/models/auto-job.ts +132 -0
- package/src/models/auto-schedule.ts +2 -2
- package/src/models/auto-when-in.ts +36 -0
- package/src/models/auto-when-out.ts +45 -0
- package/src/models/benchmark-claim-row.ts +12 -0
- package/src/models/{benchmark-published-claim.ts → benchmark-claim.ts} +23 -11
- package/src/models/benchmark-leader-row.ts +12 -0
- package/src/models/benchmark-put-claims-in.ts +3 -3
- package/src/models/billing-assignment.ts +33 -0
- package/src/models/billing-auto-recharge.ts +6 -0
- package/src/models/billing-invoice-ref.ts +36 -0
- package/src/models/billing-resize.ts +39 -0
- package/src/models/billing-sale-line.ts +36 -0
- package/src/models/{billing-subscription-ref.ts → billing-subscription-act.ts} +6 -6
- package/src/models/billing-subscription-line.ts +60 -0
- package/src/models/billing-subscription-plan.ts +6 -0
- package/src/models/billing-subscription-seat.ts +36 -0
- package/src/models/billing-subscription.ts +30 -0
- package/src/models/brief.ts +72 -0
- package/src/models/capture-event.ts +6 -0
- package/src/models/capture-result.ts +6 -0
- package/src/models/{pricing-price.ts → chat-turn.ts} +20 -14
- package/src/models/compliance-wire.ts +6 -0
- package/src/models/compute-byo-worker.ts +15 -0
- package/src/models/compute-lane-model.ts +42 -0
- package/src/models/decision.ts +2 -8
- package/src/models/delivery.ts +60 -0
- package/src/models/flag-platform-out.ts +1 -1
- package/src/models/framework-install.ts +6 -0
- package/src/models/gateway-policy.ts +8 -2
- package/src/models/graph-qlerror.ts +2 -2
- package/src/models/index.ts +77 -8
- package/src/models/kms-kms-health.ts +7 -1
- package/src/models/library-item-page.ts +39 -0
- package/src/models/library-item-patch.ts +48 -0
- package/src/models/library-keep-in.ts +108 -0
- package/src/models/library-library-item.ts +162 -0
- package/src/models/marketing-address.ts +54 -0
- package/src/models/marketing-answer.ts +36 -0
- package/src/models/marketing-beta-act-in.ts +42 -0
- package/src/models/{pricing-rate-window.ts → marketing-beta-action.ts} +16 -16
- package/src/models/marketing-beta-answer.ts +42 -0
- package/src/models/marketing-beta-in.ts +51 -0
- package/src/models/marketing-beta-request.ts +30 -0
- package/src/models/marketing-beta.ts +102 -0
- package/src/models/marketing-esign-document.ts +45 -0
- package/src/models/marketing-esign-event.ts +39 -0
- package/src/models/marketing-esign-recipient.ts +36 -0
- package/src/models/marketing-lead-in.ts +100 -1
- package/src/models/marketing-lead.ts +13 -1
- package/src/models/marketing-mail-in.ts +48 -0
- package/src/models/marketing-mail-out.ts +36 -0
- package/src/models/marketing-resume-form.ts +48 -0
- package/src/models/marketing-resume-in.ts +42 -0
- package/src/models/marketing-signing.ts +30 -0
- package/src/models/marketing-step.ts +1 -1
- package/src/models/marketing-tags.ts +54 -0
- package/src/models/marketing-visit.ts +1 -1
- package/src/models/platform-app-out.ts +1 -1
- package/src/models/platform-domain-view.ts +1 -1
- package/src/models/project-projects-project.ts +6 -0
- package/src/models/replay-body.ts +6 -0
- package/src/models/routing-version.ts +6 -0
- package/src/models/studio-brand-page.ts +39 -0
- package/src/models/studio-brand-patch.ts +54 -0
- package/src/models/studio-brand-write.ts +48 -0
- package/src/models/studio-brand.ts +78 -0
- package/src/models/studio-document-page.ts +39 -0
- package/src/models/studio-document-patch.ts +57 -0
- package/src/models/studio-document-write.ts +57 -0
- package/src/models/studio-document.ts +87 -0
- package/src/models/studio-estimate.ts +39 -0
- package/src/models/studio-flow-page.ts +39 -0
- package/src/models/studio-flow-patch.ts +69 -0
- package/src/models/studio-flow-write.ts +63 -0
- package/src/models/studio-flow.ts +93 -0
- package/src/models/studio-gpu-list.ts +33 -0
- package/src/models/studio-gpu.ts +66 -0
- package/src/models/studio-graph.ts +33 -0
- package/src/models/studio-ir.ts +36 -0
- package/src/models/studio-item.ts +144 -0
- package/src/models/studio-message.ts +60 -0
- package/src/models/studio-problem.ts +54 -0
- package/src/models/studio-run-create.ts +75 -0
- package/src/models/studio-run-page.ts +39 -0
- package/src/models/studio-run-patch.ts +42 -0
- package/src/models/studio-run.ts +180 -0
- package/src/models/studio-spec.ts +54 -0
- package/src/models/studio-step-price.ts +42 -0
- package/src/models/studio-step.ts +117 -0
- package/src/models/studio-template-page.ts +39 -0
- package/src/models/studio-template-patch.ts +69 -0
- package/src/models/studio-template-write.ts +69 -0
- package/src/models/studio-template.ts +99 -0
- package/src/models/studio-thread-card.ts +42 -0
- package/src/models/studio-thread-page.ts +39 -0
- package/src/models/studio-thread.ts +69 -0
- package/src/models/{ai-per-million.ts → tally.ts} +16 -10
- package/src/models/translate-memory-entry.ts +24 -0
- package/src/models/translate-review-request.ts +18 -0
- package/src/models/translation.ts +54 -0
- package/dist/esm/models/pricing-enso-out.d.ts +0 -49
- package/dist/esm/models/pricing-quote.d.ts +0 -75
- package/dist/esm/models/pricing-rate-arm.d.ts +0 -61
- package/dist/esm/models/pricing-rate-window.d.ts +0 -42
- package/dist/models/pricing-enso-out.d.ts +0 -49
- package/dist/models/pricing-quote.d.ts +0 -75
- package/dist/models/pricing-rate-arm.d.ts +0 -61
- package/dist/models/pricing-rate-window.d.ts +0 -42
- package/src/models/pricing-enso-out.ts +0 -57
- package/src/models/pricing-quote.ts +0 -87
- package/src/models/pricing-rate-arm.ts +0 -69
- /package/dist/esm/models/{ai-per-million.js → agent-coding-ack.js} +0 -0
- /package/dist/esm/models/{benchmark-published-claim.js → agent-coding-instruction.js} +0 -0
- /package/dist/esm/models/{billing-subscription-ref.js → ai-video-spec.js} +0 -0
- /package/dist/esm/models/{pricing-enso-out.js → ai-voice-spec.js} +0 -0
- /package/dist/esm/models/{pricing-price.js → auto-job-page.js} +0 -0
- /package/dist/esm/models/{pricing-quote.js → auto-job.js} +0 -0
- /package/dist/esm/models/{pricing-rate-arm.js → auto-when-in.js} +0 -0
- /package/dist/esm/models/{pricing-rate-window.js → auto-when-out.js} +0 -0
- /package/dist/models/{ai-per-million.js → agent-coding-ack.js} +0 -0
- /package/dist/models/{benchmark-published-claim.js → agent-coding-instruction.js} +0 -0
- /package/dist/models/{billing-subscription-ref.js → ai-video-spec.js} +0 -0
- /package/dist/models/{pricing-enso-out.js → ai-voice-spec.js} +0 -0
- /package/dist/models/{pricing-price.js → auto-job-page.js} +0 -0
- /package/dist/models/{pricing-quote.js → auto-job.js} +0 -0
- /package/dist/models/{pricing-rate-arm.js → auto-when-in.js} +0 -0
- /package/dist/models/{pricing-rate-window.js → auto-when-out.js} +0 -0
package/src/api/commerce-api.ts
CHANGED
|
@@ -716,44 +716,6 @@ export const CommerceApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
716
716
|
|
|
717
717
|
|
|
718
718
|
|
|
719
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
720
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
721
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
722
|
-
|
|
723
|
-
return {
|
|
724
|
-
url: toPathString(localVarUrlObj),
|
|
725
|
-
options: localVarRequestOptions,
|
|
726
|
-
};
|
|
727
|
-
},
|
|
728
|
-
/**
|
|
729
|
-
* A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY. Two things to know before registering one: that token is a plainly readable field, so anyone who may read webhooks reads every endpoint\'s secret, and delivery consults only the all flag and the event map — it does NOT consult enabled or live, so setting enabled false does not stop delivery and deleting the row is the only thing that does. Delivery is a single POST with a twenty-second timeout and no retry. Removes the addressed row and answers 204 with no body. Before the live row goes it is written once more under a deleted tombstone kind, so a deletion leaves a recoverable copy rather than destroying the record outright — and a tombstone that cannot be written fails the call with 500 before anything is removed. The id is resolved inside the caller org\'s own namespace, so an absent or foreign id is 404. The token must carry the ADMIN permission; an ordinary access token is refused. The per-kind permission table has no entry for webhook, so the scaffold skips that second check with a warning and the gate above is the whole authorization story.
|
|
730
|
-
* @summary Delete a webhook, keeping a recoverable copy
|
|
731
|
-
* @param {string} webhookid
|
|
732
|
-
* @param {*} [options] Override http request option.
|
|
733
|
-
* @throws {RequiredError}
|
|
734
|
-
*/
|
|
735
|
-
deleteCommerceWebhookByWebhookid: async (webhookid: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
736
|
-
// verify required parameter 'webhookid' is not null or undefined
|
|
737
|
-
assertParamExists('deleteCommerceWebhookByWebhookid', 'webhookid', webhookid)
|
|
738
|
-
const localVarPath = `/v1/commerce/webhook/{webhookid}`
|
|
739
|
-
.replace(`{${"webhookid"}}`, encodeURIComponent(String(webhookid)));
|
|
740
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
741
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
742
|
-
let baseOptions;
|
|
743
|
-
if (configuration) {
|
|
744
|
-
baseOptions = configuration.baseOptions;
|
|
745
|
-
}
|
|
746
|
-
|
|
747
|
-
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
748
|
-
const localVarHeaderParameter = {} as any;
|
|
749
|
-
const localVarQueryParameter = {} as any;
|
|
750
|
-
|
|
751
|
-
// authentication bearer required
|
|
752
|
-
// http bearer authentication required
|
|
753
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
719
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
758
720
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
759
721
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -2464,78 +2426,6 @@ export const CommerceApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
2464
2426
|
|
|
2465
2427
|
|
|
2466
2428
|
|
|
2467
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2468
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2469
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2470
|
-
|
|
2471
|
-
return {
|
|
2472
|
-
url: toPathString(localVarUrlObj),
|
|
2473
|
-
options: localVarRequestOptions,
|
|
2474
|
-
};
|
|
2475
|
-
},
|
|
2476
|
-
/**
|
|
2477
|
-
* A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY. Two things to know before registering one: that token is a plainly readable field, so anyone who may read webhooks reads every endpoint\'s secret, and delivery consults only the all flag and the event map — it does NOT consult enabled or live, so setting enabled false does not stop delivery and deleting the row is the only thing that does. Delivery is a single POST with a twenty-second timeout and no retry. Answers a pagination envelope — the page and display echoed back, the rows under models, a total count and a facets array — read from the caller org\'s own namespaced store, so one tenant can never list another\'s. Sorting defaults to the last-updated time and is overridable with sort. display is the page size and page applies only alongside it; either one that is not a positive integer is refused with 500 rather than silently ignored, and the limit query overrides the reported COUNT only, never the rows returned. No search backend is wired, so the datastore is the one and only list path and facets is always empty. A request resolving no org namespace is served an EMPTY page rather than an unscoped scan: the namespace IS the tenant filter, so without one there is nothing safe to return. The token must carry the ADMIN permission; an ordinary access token is refused. The per-kind permission table has no entry for webhook, so the scaffold skips that second check with a warning and the gate above is the whole authorization story.
|
|
2478
|
-
* @summary List your org\'s webhooks, as a page
|
|
2479
|
-
* @param {*} [options] Override http request option.
|
|
2480
|
-
* @throws {RequiredError}
|
|
2481
|
-
*/
|
|
2482
|
-
getCommerceWebhook: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2483
|
-
const localVarPath = `/v1/commerce/webhook`;
|
|
2484
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2485
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2486
|
-
let baseOptions;
|
|
2487
|
-
if (configuration) {
|
|
2488
|
-
baseOptions = configuration.baseOptions;
|
|
2489
|
-
}
|
|
2490
|
-
|
|
2491
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
2492
|
-
const localVarHeaderParameter = {} as any;
|
|
2493
|
-
const localVarQueryParameter = {} as any;
|
|
2494
|
-
|
|
2495
|
-
// authentication bearer required
|
|
2496
|
-
// http bearer authentication required
|
|
2497
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
2498
|
-
|
|
2499
|
-
|
|
2500
|
-
|
|
2501
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2502
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2503
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2504
|
-
|
|
2505
|
-
return {
|
|
2506
|
-
url: toPathString(localVarUrlObj),
|
|
2507
|
-
options: localVarRequestOptions,
|
|
2508
|
-
};
|
|
2509
|
-
},
|
|
2510
|
-
/**
|
|
2511
|
-
* A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY. Two things to know before registering one: that token is a plainly readable field, so anyone who may read webhooks reads every endpoint\'s secret, and delivery consults only the all flag and the event map — it does NOT consult enabled or live, so setting enabled false does not stop delivery and deleting the row is the only thing that does. Delivery is a single POST with a twenty-second timeout and no retry. Reads the addressed row from the caller org\'s own namespaced store. An id that is not there is 404 — and another tenant\'s id is not there by construction, so it reads exactly like a typo instead of confirming the row exists somewhere else. The token must carry the ADMIN permission; an ordinary access token is refused. The per-kind permission table has no entry for webhook, so the scaffold skips that second check with a warning and the gate above is the whole authorization story.
|
|
2512
|
-
* @summary Fetch one webhook
|
|
2513
|
-
* @param {string} webhookid
|
|
2514
|
-
* @param {*} [options] Override http request option.
|
|
2515
|
-
* @throws {RequiredError}
|
|
2516
|
-
*/
|
|
2517
|
-
getCommerceWebhookByWebhookid: async (webhookid: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2518
|
-
// verify required parameter 'webhookid' is not null or undefined
|
|
2519
|
-
assertParamExists('getCommerceWebhookByWebhookid', 'webhookid', webhookid)
|
|
2520
|
-
const localVarPath = `/v1/commerce/webhook/{webhookid}`
|
|
2521
|
-
.replace(`{${"webhookid"}}`, encodeURIComponent(String(webhookid)));
|
|
2522
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2523
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2524
|
-
let baseOptions;
|
|
2525
|
-
if (configuration) {
|
|
2526
|
-
baseOptions = configuration.baseOptions;
|
|
2527
|
-
}
|
|
2528
|
-
|
|
2529
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
2530
|
-
const localVarHeaderParameter = {} as any;
|
|
2531
|
-
const localVarQueryParameter = {} as any;
|
|
2532
|
-
|
|
2533
|
-
// authentication bearer required
|
|
2534
|
-
// http bearer authentication required
|
|
2535
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
2536
|
-
|
|
2537
|
-
|
|
2538
|
-
|
|
2539
2429
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2540
2430
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2541
2431
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -3264,44 +3154,6 @@ export const CommerceApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
3264
3154
|
|
|
3265
3155
|
|
|
3266
3156
|
|
|
3267
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3268
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3269
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3270
|
-
|
|
3271
|
-
return {
|
|
3272
|
-
url: toPathString(localVarUrlObj),
|
|
3273
|
-
options: localVarRequestOptions,
|
|
3274
|
-
};
|
|
3275
|
-
},
|
|
3276
|
-
/**
|
|
3277
|
-
* A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY. Two things to know before registering one: that token is a plainly readable field, so anyone who may read webhooks reads every endpoint\'s secret, and delivery consults only the all flag and the event map — it does NOT consult enabled or live, so setting enabled false does not stop delivery and deleting the row is the only thing that does. Delivery is a single POST with a twenty-second timeout and no retry. Loads the stored row and decodes the body OVER it, so only the fields the body names change and everything else keeps its stored value — the difference from the full replace, which clears what it is not told. Answers the merged row. An id absent from the caller org\'s namespace is 404 and a body that fails to decode is 400. The token must carry the ADMIN permission; an ordinary access token is refused. The per-kind permission table has no entry for webhook, so the scaffold skips that second check with a warning and the gate above is the whole authorization story.
|
|
3278
|
-
* @summary Change part of a webhook
|
|
3279
|
-
* @param {string} webhookid
|
|
3280
|
-
* @param {*} [options] Override http request option.
|
|
3281
|
-
* @throws {RequiredError}
|
|
3282
|
-
*/
|
|
3283
|
-
patchCommerceWebhookByWebhookid: async (webhookid: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3284
|
-
// verify required parameter 'webhookid' is not null or undefined
|
|
3285
|
-
assertParamExists('patchCommerceWebhookByWebhookid', 'webhookid', webhookid)
|
|
3286
|
-
const localVarPath = `/v1/commerce/webhook/{webhookid}`
|
|
3287
|
-
.replace(`{${"webhookid"}}`, encodeURIComponent(String(webhookid)));
|
|
3288
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3289
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3290
|
-
let baseOptions;
|
|
3291
|
-
if (configuration) {
|
|
3292
|
-
baseOptions = configuration.baseOptions;
|
|
3293
|
-
}
|
|
3294
|
-
|
|
3295
|
-
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
3296
|
-
const localVarHeaderParameter = {} as any;
|
|
3297
|
-
const localVarQueryParameter = {} as any;
|
|
3298
|
-
|
|
3299
|
-
// authentication bearer required
|
|
3300
|
-
// http bearer authentication required
|
|
3301
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
3302
|
-
|
|
3303
|
-
|
|
3304
|
-
|
|
3305
3157
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3306
3158
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3307
3159
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -5282,79 +5134,7 @@ export const CommerceApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
5282
5134
|
};
|
|
5283
5135
|
},
|
|
5284
5136
|
/**
|
|
5285
|
-
*
|
|
5286
|
-
* @summary Create a webhook
|
|
5287
|
-
* @param {*} [options] Override http request option.
|
|
5288
|
-
* @throws {RequiredError}
|
|
5289
|
-
*/
|
|
5290
|
-
postCommerceWebhook: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
5291
|
-
const localVarPath = `/v1/commerce/webhook`;
|
|
5292
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5293
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5294
|
-
let baseOptions;
|
|
5295
|
-
if (configuration) {
|
|
5296
|
-
baseOptions = configuration.baseOptions;
|
|
5297
|
-
}
|
|
5298
|
-
|
|
5299
|
-
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
5300
|
-
const localVarHeaderParameter = {} as any;
|
|
5301
|
-
const localVarQueryParameter = {} as any;
|
|
5302
|
-
|
|
5303
|
-
// authentication bearer required
|
|
5304
|
-
// http bearer authentication required
|
|
5305
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
5306
|
-
|
|
5307
|
-
|
|
5308
|
-
|
|
5309
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5310
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5311
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
5312
|
-
|
|
5313
|
-
return {
|
|
5314
|
-
url: toPathString(localVarUrlObj),
|
|
5315
|
-
options: localVarRequestOptions,
|
|
5316
|
-
};
|
|
5317
|
-
},
|
|
5318
|
-
/**
|
|
5319
|
-
* A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY. Two things to know before registering one: that token is a plainly readable field, so anyone who may read webhooks reads every endpoint\'s secret, and delivery consults only the all flag and the event map — it does NOT consult enabled or live, so setting enabled false does not stop delivery and deleting the row is the only thing that does. Delivery is a single POST with a twenty-second timeout and no retry. Re-dispatches the request into the handler the intended verb would have reached, taking that verb from a _method form value or query parameter and then from the X-HTTP-Method-Override header. PUT replaces the row, PATCH changes part of it, DELETE removes it, and anything else is 405. The trap is the DEFAULT: naming no override at all leaves the method POST, which this tunnel maps to the PARTIAL UPDATE — it is never a create, and creating is the collection root\'s job. Behaviour and authorization are the underlying operation\'s, since the real handler runs. The token must carry the ADMIN permission; an ordinary access token is refused.
|
|
5320
|
-
* @summary Method-override tunnel for a webhook — for clients that cannot send PUT, PATCH or DELETE
|
|
5321
|
-
* @param {string} webhookid
|
|
5322
|
-
* @param {*} [options] Override http request option.
|
|
5323
|
-
* @throws {RequiredError}
|
|
5324
|
-
*/
|
|
5325
|
-
postCommerceWebhookByWebhookid: async (webhookid: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
5326
|
-
// verify required parameter 'webhookid' is not null or undefined
|
|
5327
|
-
assertParamExists('postCommerceWebhookByWebhookid', 'webhookid', webhookid)
|
|
5328
|
-
const localVarPath = `/v1/commerce/webhook/{webhookid}`
|
|
5329
|
-
.replace(`{${"webhookid"}}`, encodeURIComponent(String(webhookid)));
|
|
5330
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5331
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5332
|
-
let baseOptions;
|
|
5333
|
-
if (configuration) {
|
|
5334
|
-
baseOptions = configuration.baseOptions;
|
|
5335
|
-
}
|
|
5336
|
-
|
|
5337
|
-
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
5338
|
-
const localVarHeaderParameter = {} as any;
|
|
5339
|
-
const localVarQueryParameter = {} as any;
|
|
5340
|
-
|
|
5341
|
-
// authentication bearer required
|
|
5342
|
-
// http bearer authentication required
|
|
5343
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
5344
|
-
|
|
5345
|
-
|
|
5346
|
-
|
|
5347
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5348
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5349
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
5350
|
-
|
|
5351
|
-
return {
|
|
5352
|
-
url: toPathString(localVarUrlObj),
|
|
5353
|
-
options: localVarRequestOptions,
|
|
5354
|
-
};
|
|
5355
|
-
},
|
|
5356
|
-
/**
|
|
5357
|
-
* Accepts a payment provider\'s event, verifies it, records it for audit, and applies subscription lifecycle changes to the matching local row. There is no bearer here and there cannot be: the provider\'s SIGNATURE over the body IS the authentication, so a request with no recognized signature header is 400 and one whose signature does not verify is 401. The provider path segment is only a hint for dashboard configuration — verification picks the processor regardless of what the URL says. Redelivery is safe: an event id already recorded is acknowledged as a duplicate without re-applying any side effect, which matters because providers retry for days until they see a 2xx.
|
|
5137
|
+
* Accepts a payment provider\'s event, verifies it, applies its settlement, refund, dispute and subscription effects, and records it for audit. There is no bearer here and there cannot be: the provider\'s SIGNATURE over the body IS the authentication, so a request with no recognized signature header is 400 and one whose signature does not verify is 401. The path names the one processor that verifies, and only a processor holding its webhook secret may; any other name is 401. Each event is applied once for the whole deployment: a redelivery of an applied event is acknowledged as a duplicate, one still being applied is 409, and an event whose effect could not land is 503 so the provider redelivers it.
|
|
5358
5138
|
* @summary Payment-provider webhook intake for settlement and subscription lifecycle events
|
|
5359
5139
|
* @param {string} provider
|
|
5360
5140
|
* @param {*} [options] Override http request option.
|
|
@@ -6070,44 +5850,6 @@ export const CommerceApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
6070
5850
|
|
|
6071
5851
|
|
|
6072
5852
|
|
|
6073
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6074
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6075
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6076
|
-
|
|
6077
|
-
return {
|
|
6078
|
-
url: toPathString(localVarUrlObj),
|
|
6079
|
-
options: localVarRequestOptions,
|
|
6080
|
-
};
|
|
6081
|
-
},
|
|
6082
|
-
/**
|
|
6083
|
-
* A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY. Two things to know before registering one: that token is a plainly readable field, so anyone who may read webhooks reads every endpoint\'s secret, and delivery consults only the all flag and the event map — it does NOT consult enabled or live, so setting enabled false does not stop delivery and deleting the row is the only thing that does. Delivery is a single POST with a twenty-second timeout and no retry. This is a true REPLACEMENT, not a merge: the stored row\'s key is preserved, but the body is decoded onto a FRESH entity, so every field the body omits is written back as its ZERO value. Patch is the verb for changing part of a row. The id is resolved inside the caller org\'s own namespace and an absent one is 404 before anything is written; a body that fails to decode is 400. Answers the stored result. The token must carry the ADMIN permission; an ordinary access token is refused. The per-kind permission table has no entry for webhook, so the scaffold skips that second check with a warning and the gate above is the whole authorization story.
|
|
6084
|
-
* @summary Replace a webhook outright
|
|
6085
|
-
* @param {string} webhookid
|
|
6086
|
-
* @param {*} [options] Override http request option.
|
|
6087
|
-
* @throws {RequiredError}
|
|
6088
|
-
*/
|
|
6089
|
-
putCommerceWebhookByWebhookid: async (webhookid: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6090
|
-
// verify required parameter 'webhookid' is not null or undefined
|
|
6091
|
-
assertParamExists('putCommerceWebhookByWebhookid', 'webhookid', webhookid)
|
|
6092
|
-
const localVarPath = `/v1/commerce/webhook/{webhookid}`
|
|
6093
|
-
.replace(`{${"webhookid"}}`, encodeURIComponent(String(webhookid)));
|
|
6094
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6095
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6096
|
-
let baseOptions;
|
|
6097
|
-
if (configuration) {
|
|
6098
|
-
baseOptions = configuration.baseOptions;
|
|
6099
|
-
}
|
|
6100
|
-
|
|
6101
|
-
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
6102
|
-
const localVarHeaderParameter = {} as any;
|
|
6103
|
-
const localVarQueryParameter = {} as any;
|
|
6104
|
-
|
|
6105
|
-
// authentication bearer required
|
|
6106
|
-
// http bearer authentication required
|
|
6107
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6108
|
-
|
|
6109
|
-
|
|
6110
|
-
|
|
6111
5853
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6112
5854
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6113
5855
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -6406,19 +6148,6 @@ export const CommerceApiFp = function(configuration?: Configuration) {
|
|
|
6406
6148
|
const localVarOperationServerBasePath = operationServerMap['CommerceApi.deleteCommerceWatchlistByWatchlistid']?.[localVarOperationServerIndex]?.url;
|
|
6407
6149
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6408
6150
|
},
|
|
6409
|
-
/**
|
|
6410
|
-
* A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY. Two things to know before registering one: that token is a plainly readable field, so anyone who may read webhooks reads every endpoint\'s secret, and delivery consults only the all flag and the event map — it does NOT consult enabled or live, so setting enabled false does not stop delivery and deleting the row is the only thing that does. Delivery is a single POST with a twenty-second timeout and no retry. Removes the addressed row and answers 204 with no body. Before the live row goes it is written once more under a deleted tombstone kind, so a deletion leaves a recoverable copy rather than destroying the record outright — and a tombstone that cannot be written fails the call with 500 before anything is removed. The id is resolved inside the caller org\'s own namespace, so an absent or foreign id is 404. The token must carry the ADMIN permission; an ordinary access token is refused. The per-kind permission table has no entry for webhook, so the scaffold skips that second check with a warning and the gate above is the whole authorization story.
|
|
6411
|
-
* @summary Delete a webhook, keeping a recoverable copy
|
|
6412
|
-
* @param {string} webhookid
|
|
6413
|
-
* @param {*} [options] Override http request option.
|
|
6414
|
-
* @throws {RequiredError}
|
|
6415
|
-
*/
|
|
6416
|
-
async deleteCommerceWebhookByWebhookid(webhookid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
6417
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCommerceWebhookByWebhookid(webhookid, options);
|
|
6418
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6419
|
-
const localVarOperationServerBasePath = operationServerMap['CommerceApi.deleteCommerceWebhookByWebhookid']?.[localVarOperationServerIndex]?.url;
|
|
6420
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6421
|
-
},
|
|
6422
6151
|
/**
|
|
6423
6152
|
* Discards a cart the shopper abandoned, and answers it in its final state. A discarded cart is CLOSED, not deleted: the row stays, so abandoned-basket reporting and any follow-up that keys on it still have something to read. It stops being a cart anything will check out, which is the point — it is how a storefront says \"this basket is over\" without destroying the evidence that it existed. Discarding is idempotent: a cart already discarded answers its stored state rather than failing, so a retry is safe. The cart is resolved inside the caller\'s own org namespace, so another tenant\'s id answers 404. A named handler, not a closure, so zipdoc can lift this prose into the registry.
|
|
6424
6153
|
* @summary Discard a cart the shopper abandoned
|
|
@@ -7011,31 +6740,6 @@ export const CommerceApiFp = function(configuration?: Configuration) {
|
|
|
7011
6740
|
const localVarOperationServerBasePath = operationServerMap['CommerceApi.getCommerceWatchlistByWatchlistid']?.[localVarOperationServerIndex]?.url;
|
|
7012
6741
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7013
6742
|
},
|
|
7014
|
-
/**
|
|
7015
|
-
* A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY. Two things to know before registering one: that token is a plainly readable field, so anyone who may read webhooks reads every endpoint\'s secret, and delivery consults only the all flag and the event map — it does NOT consult enabled or live, so setting enabled false does not stop delivery and deleting the row is the only thing that does. Delivery is a single POST with a twenty-second timeout and no retry. Answers a pagination envelope — the page and display echoed back, the rows under models, a total count and a facets array — read from the caller org\'s own namespaced store, so one tenant can never list another\'s. Sorting defaults to the last-updated time and is overridable with sort. display is the page size and page applies only alongside it; either one that is not a positive integer is refused with 500 rather than silently ignored, and the limit query overrides the reported COUNT only, never the rows returned. No search backend is wired, so the datastore is the one and only list path and facets is always empty. A request resolving no org namespace is served an EMPTY page rather than an unscoped scan: the namespace IS the tenant filter, so without one there is nothing safe to return. The token must carry the ADMIN permission; an ordinary access token is refused. The per-kind permission table has no entry for webhook, so the scaffold skips that second check with a warning and the gate above is the whole authorization story.
|
|
7016
|
-
* @summary List your org\'s webhooks, as a page
|
|
7017
|
-
* @param {*} [options] Override http request option.
|
|
7018
|
-
* @throws {RequiredError}
|
|
7019
|
-
*/
|
|
7020
|
-
async getCommerceWebhook(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
7021
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getCommerceWebhook(options);
|
|
7022
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7023
|
-
const localVarOperationServerBasePath = operationServerMap['CommerceApi.getCommerceWebhook']?.[localVarOperationServerIndex]?.url;
|
|
7024
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7025
|
-
},
|
|
7026
|
-
/**
|
|
7027
|
-
* A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY. Two things to know before registering one: that token is a plainly readable field, so anyone who may read webhooks reads every endpoint\'s secret, and delivery consults only the all flag and the event map — it does NOT consult enabled or live, so setting enabled false does not stop delivery and deleting the row is the only thing that does. Delivery is a single POST with a twenty-second timeout and no retry. Reads the addressed row from the caller org\'s own namespaced store. An id that is not there is 404 — and another tenant\'s id is not there by construction, so it reads exactly like a typo instead of confirming the row exists somewhere else. The token must carry the ADMIN permission; an ordinary access token is refused. The per-kind permission table has no entry for webhook, so the scaffold skips that second check with a warning and the gate above is the whole authorization story.
|
|
7028
|
-
* @summary Fetch one webhook
|
|
7029
|
-
* @param {string} webhookid
|
|
7030
|
-
* @param {*} [options] Override http request option.
|
|
7031
|
-
* @throws {RequiredError}
|
|
7032
|
-
*/
|
|
7033
|
-
async getCommerceWebhookByWebhookid(webhookid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
7034
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getCommerceWebhookByWebhookid(webhookid, options);
|
|
7035
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7036
|
-
const localVarOperationServerBasePath = operationServerMap['CommerceApi.getCommerceWebhookByWebhookid']?.[localVarOperationServerIndex]?.url;
|
|
7037
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7038
|
-
},
|
|
7039
6743
|
/**
|
|
7040
6744
|
* Opens an empty cart for a shopper to fill, and answers it with its new id. This is the first step of a sale: hold the id, add items to it with setCartItem, then hand it to checkout. Every field of the request is optional — an empty body opens a perfectly good anonymous cart — and the fields exist only to pre-fill what is already known about the shopper. The STORE defaults to the org\'s own default storefront, so a merchant selling through one storefront never has to name it. The CURRENCY defaults to usd; note that checkout overrides it with the store\'s own currency when the sale is authorized, so a currency set here is a hint rather than a commitment. The cart is created in the CALLER\'S OWN org namespace, taken from the validated principal and never from the body, so a cart can never be opened on another tenant\'s books. A named handler, not a closure, so zipdoc can lift this prose into the registry.
|
|
7041
6745
|
* @summary Open a cart for a shopper to fill
|
|
@@ -7284,19 +6988,6 @@ export const CommerceApiFp = function(configuration?: Configuration) {
|
|
|
7284
6988
|
const localVarOperationServerBasePath = operationServerMap['CommerceApi.patchCommerceWatchlistByWatchlistid']?.[localVarOperationServerIndex]?.url;
|
|
7285
6989
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7286
6990
|
},
|
|
7287
|
-
/**
|
|
7288
|
-
* A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY. Two things to know before registering one: that token is a plainly readable field, so anyone who may read webhooks reads every endpoint\'s secret, and delivery consults only the all flag and the event map — it does NOT consult enabled or live, so setting enabled false does not stop delivery and deleting the row is the only thing that does. Delivery is a single POST with a twenty-second timeout and no retry. Loads the stored row and decodes the body OVER it, so only the fields the body names change and everything else keeps its stored value — the difference from the full replace, which clears what it is not told. Answers the merged row. An id absent from the caller org\'s namespace is 404 and a body that fails to decode is 400. The token must carry the ADMIN permission; an ordinary access token is refused. The per-kind permission table has no entry for webhook, so the scaffold skips that second check with a warning and the gate above is the whole authorization story.
|
|
7289
|
-
* @summary Change part of a webhook
|
|
7290
|
-
* @param {string} webhookid
|
|
7291
|
-
* @param {*} [options] Override http request option.
|
|
7292
|
-
* @throws {RequiredError}
|
|
7293
|
-
*/
|
|
7294
|
-
async patchCommerceWebhookByWebhookid(webhookid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
7295
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.patchCommerceWebhookByWebhookid(webhookid, options);
|
|
7296
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7297
|
-
const localVarOperationServerBasePath = operationServerMap['CommerceApi.patchCommerceWebhookByWebhookid']?.[localVarOperationServerIndex]?.url;
|
|
7298
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7299
|
-
},
|
|
7300
6991
|
/**
|
|
7301
6992
|
* Takes a batch of model rows and upserts each one\'s upstream COST and machine-observable facts, answering what was created and changed. It deliberately touches nothing a human owns — not the retail price, not the markup, not the entitlement tier — so a sync can never overwrite an administrator\'s pricing decision. The gate is a PLATFORM principal rather than a platform ADMIN, because the caller is normally a scheduled job — the platform\'s own application, an IAM identity under the admin org.
|
|
7302
6993
|
* @summary Land a syncer\'s view of the model catalog: upstream costs and machine facts
|
|
@@ -7976,32 +7667,7 @@ export const CommerceApiFp = function(configuration?: Configuration) {
|
|
|
7976
7667
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7977
7668
|
},
|
|
7978
7669
|
/**
|
|
7979
|
-
*
|
|
7980
|
-
* @summary Create a webhook
|
|
7981
|
-
* @param {*} [options] Override http request option.
|
|
7982
|
-
* @throws {RequiredError}
|
|
7983
|
-
*/
|
|
7984
|
-
async postCommerceWebhook(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
7985
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.postCommerceWebhook(options);
|
|
7986
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7987
|
-
const localVarOperationServerBasePath = operationServerMap['CommerceApi.postCommerceWebhook']?.[localVarOperationServerIndex]?.url;
|
|
7988
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7989
|
-
},
|
|
7990
|
-
/**
|
|
7991
|
-
* A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY. Two things to know before registering one: that token is a plainly readable field, so anyone who may read webhooks reads every endpoint\'s secret, and delivery consults only the all flag and the event map — it does NOT consult enabled or live, so setting enabled false does not stop delivery and deleting the row is the only thing that does. Delivery is a single POST with a twenty-second timeout and no retry. Re-dispatches the request into the handler the intended verb would have reached, taking that verb from a _method form value or query parameter and then from the X-HTTP-Method-Override header. PUT replaces the row, PATCH changes part of it, DELETE removes it, and anything else is 405. The trap is the DEFAULT: naming no override at all leaves the method POST, which this tunnel maps to the PARTIAL UPDATE — it is never a create, and creating is the collection root\'s job. Behaviour and authorization are the underlying operation\'s, since the real handler runs. The token must carry the ADMIN permission; an ordinary access token is refused.
|
|
7992
|
-
* @summary Method-override tunnel for a webhook — for clients that cannot send PUT, PATCH or DELETE
|
|
7993
|
-
* @param {string} webhookid
|
|
7994
|
-
* @param {*} [options] Override http request option.
|
|
7995
|
-
* @throws {RequiredError}
|
|
7996
|
-
*/
|
|
7997
|
-
async postCommerceWebhookByWebhookid(webhookid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
7998
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.postCommerceWebhookByWebhookid(webhookid, options);
|
|
7999
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8000
|
-
const localVarOperationServerBasePath = operationServerMap['CommerceApi.postCommerceWebhookByWebhookid']?.[localVarOperationServerIndex]?.url;
|
|
8001
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8002
|
-
},
|
|
8003
|
-
/**
|
|
8004
|
-
* Accepts a payment provider\'s event, verifies it, records it for audit, and applies subscription lifecycle changes to the matching local row. There is no bearer here and there cannot be: the provider\'s SIGNATURE over the body IS the authentication, so a request with no recognized signature header is 400 and one whose signature does not verify is 401. The provider path segment is only a hint for dashboard configuration — verification picks the processor regardless of what the URL says. Redelivery is safe: an event id already recorded is acknowledged as a duplicate without re-applying any side effect, which matters because providers retry for days until they see a 2xx.
|
|
7670
|
+
* Accepts a payment provider\'s event, verifies it, applies its settlement, refund, dispute and subscription effects, and records it for audit. There is no bearer here and there cannot be: the provider\'s SIGNATURE over the body IS the authentication, so a request with no recognized signature header is 400 and one whose signature does not verify is 401. The path names the one processor that verifies, and only a processor holding its webhook secret may; any other name is 401. Each event is applied once for the whole deployment: a redelivery of an applied event is acknowledged as a duplicate, one still being applied is 409, and an event whose effect could not land is 503 so the provider redelivers it.
|
|
8005
7671
|
* @summary Payment-provider webhook intake for settlement and subscription lifecycle events
|
|
8006
7672
|
* @param {string} provider
|
|
8007
7673
|
* @param {*} [options] Override http request option.
|
|
@@ -8248,19 +7914,6 @@ export const CommerceApiFp = function(configuration?: Configuration) {
|
|
|
8248
7914
|
const localVarOperationServerBasePath = operationServerMap['CommerceApi.putCommerceWatchlistByWatchlistid']?.[localVarOperationServerIndex]?.url;
|
|
8249
7915
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8250
7916
|
},
|
|
8251
|
-
/**
|
|
8252
|
-
* A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY. Two things to know before registering one: that token is a plainly readable field, so anyone who may read webhooks reads every endpoint\'s secret, and delivery consults only the all flag and the event map — it does NOT consult enabled or live, so setting enabled false does not stop delivery and deleting the row is the only thing that does. Delivery is a single POST with a twenty-second timeout and no retry. This is a true REPLACEMENT, not a merge: the stored row\'s key is preserved, but the body is decoded onto a FRESH entity, so every field the body omits is written back as its ZERO value. Patch is the verb for changing part of a row. The id is resolved inside the caller org\'s own namespace and an absent one is 404 before anything is written; a body that fails to decode is 400. Answers the stored result. The token must carry the ADMIN permission; an ordinary access token is refused. The per-kind permission table has no entry for webhook, so the scaffold skips that second check with a warning and the gate above is the whole authorization story.
|
|
8253
|
-
* @summary Replace a webhook outright
|
|
8254
|
-
* @param {string} webhookid
|
|
8255
|
-
* @param {*} [options] Override http request option.
|
|
8256
|
-
* @throws {RequiredError}
|
|
8257
|
-
*/
|
|
8258
|
-
async putCommerceWebhookByWebhookid(webhookid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
8259
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.putCommerceWebhookByWebhookid(webhookid, options);
|
|
8260
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8261
|
-
const localVarOperationServerBasePath = operationServerMap['CommerceApi.putCommerceWebhookByWebhookid']?.[localVarOperationServerIndex]?.url;
|
|
8262
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8263
|
-
},
|
|
8264
7917
|
/**
|
|
8265
7918
|
* Sets how many of one item a cart holds, and answers the whole updated cart. This is the ONE way a cart\'s contents change. The quantity is the RESULT, not a delta: sending 3 leaves 3 however many were there before, so a retry is safe and a double-submit cannot double an order. ZERO REMOVES the line — there is deliberately no separate delete, because removal is the same act at the boundary value and a second spelling would be a second set of edge cases. Name the item with EITHER product OR variant, never both. Prefer variant for anything sold in sizes, colours or tiers: the price and the stock belong to the variant, so a product-level line on a varianted product prices the wrong thing. Either may be given as an id or as the human key — a product\'s URL slug, a variant\'s SKU — which is what lets a storefront add to cart straight from a product page URL without a lookup first. The item\'s price and name are CACHED onto the line as it is added, so the cart keeps the price the shopper was shown even if the catalog moves underneath it. An item that resolves to nothing in the catalog is refused 400 and the cart is left exactly as it was; nothing is partially applied. A named handler, not a closure, so zipdoc can lift this prose into the registry.
|
|
8266
7919
|
* @summary Set one item\'s quantity in a cart; zero removes it
|
|
@@ -8465,16 +8118,6 @@ export const CommerceApiFactory = function (configuration?: Configuration, baseP
|
|
|
8465
8118
|
deleteCommerceWatchlistByWatchlistid(requestParameters: CommerceApiDeleteCommerceWatchlistByWatchlistidRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
8466
8119
|
return localVarFp.deleteCommerceWatchlistByWatchlistid(requestParameters.watchlistid, options).then((request) => request(axios, basePath));
|
|
8467
8120
|
},
|
|
8468
|
-
/**
|
|
8469
|
-
* A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY. Two things to know before registering one: that token is a plainly readable field, so anyone who may read webhooks reads every endpoint\'s secret, and delivery consults only the all flag and the event map — it does NOT consult enabled or live, so setting enabled false does not stop delivery and deleting the row is the only thing that does. Delivery is a single POST with a twenty-second timeout and no retry. Removes the addressed row and answers 204 with no body. Before the live row goes it is written once more under a deleted tombstone kind, so a deletion leaves a recoverable copy rather than destroying the record outright — and a tombstone that cannot be written fails the call with 500 before anything is removed. The id is resolved inside the caller org\'s own namespace, so an absent or foreign id is 404. The token must carry the ADMIN permission; an ordinary access token is refused. The per-kind permission table has no entry for webhook, so the scaffold skips that second check with a warning and the gate above is the whole authorization story.
|
|
8470
|
-
* @summary Delete a webhook, keeping a recoverable copy
|
|
8471
|
-
* @param {CommerceApiDeleteCommerceWebhookByWebhookidRequest} requestParameters Request parameters.
|
|
8472
|
-
* @param {*} [options] Override http request option.
|
|
8473
|
-
* @throws {RequiredError}
|
|
8474
|
-
*/
|
|
8475
|
-
deleteCommerceWebhookByWebhookid(requestParameters: CommerceApiDeleteCommerceWebhookByWebhookidRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
8476
|
-
return localVarFp.deleteCommerceWebhookByWebhookid(requestParameters.webhookid, options).then((request) => request(axios, basePath));
|
|
8477
|
-
},
|
|
8478
8121
|
/**
|
|
8479
8122
|
* Discards a cart the shopper abandoned, and answers it in its final state. A discarded cart is CLOSED, not deleted: the row stays, so abandoned-basket reporting and any follow-up that keys on it still have something to read. It stops being a cart anything will check out, which is the point — it is how a storefront says \"this basket is over\" without destroying the evidence that it existed. Discarding is idempotent: a cart already discarded answers its stored state rather than failing, so a retry is safe. The cart is resolved inside the caller\'s own org namespace, so another tenant\'s id answers 404. A named handler, not a closure, so zipdoc can lift this prose into the registry.
|
|
8480
8123
|
* @summary Discard a cart the shopper abandoned
|
|
@@ -8922,25 +8565,6 @@ export const CommerceApiFactory = function (configuration?: Configuration, baseP
|
|
|
8922
8565
|
getCommerceWatchlistByWatchlistid(requestParameters: CommerceApiGetCommerceWatchlistByWatchlistidRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
8923
8566
|
return localVarFp.getCommerceWatchlistByWatchlistid(requestParameters.watchlistid, options).then((request) => request(axios, basePath));
|
|
8924
8567
|
},
|
|
8925
|
-
/**
|
|
8926
|
-
* A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY. Two things to know before registering one: that token is a plainly readable field, so anyone who may read webhooks reads every endpoint\'s secret, and delivery consults only the all flag and the event map — it does NOT consult enabled or live, so setting enabled false does not stop delivery and deleting the row is the only thing that does. Delivery is a single POST with a twenty-second timeout and no retry. Answers a pagination envelope — the page and display echoed back, the rows under models, a total count and a facets array — read from the caller org\'s own namespaced store, so one tenant can never list another\'s. Sorting defaults to the last-updated time and is overridable with sort. display is the page size and page applies only alongside it; either one that is not a positive integer is refused with 500 rather than silently ignored, and the limit query overrides the reported COUNT only, never the rows returned. No search backend is wired, so the datastore is the one and only list path and facets is always empty. A request resolving no org namespace is served an EMPTY page rather than an unscoped scan: the namespace IS the tenant filter, so without one there is nothing safe to return. The token must carry the ADMIN permission; an ordinary access token is refused. The per-kind permission table has no entry for webhook, so the scaffold skips that second check with a warning and the gate above is the whole authorization story.
|
|
8927
|
-
* @summary List your org\'s webhooks, as a page
|
|
8928
|
-
* @param {*} [options] Override http request option.
|
|
8929
|
-
* @throws {RequiredError}
|
|
8930
|
-
*/
|
|
8931
|
-
getCommerceWebhook(options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
8932
|
-
return localVarFp.getCommerceWebhook(options).then((request) => request(axios, basePath));
|
|
8933
|
-
},
|
|
8934
|
-
/**
|
|
8935
|
-
* A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY. Two things to know before registering one: that token is a plainly readable field, so anyone who may read webhooks reads every endpoint\'s secret, and delivery consults only the all flag and the event map — it does NOT consult enabled or live, so setting enabled false does not stop delivery and deleting the row is the only thing that does. Delivery is a single POST with a twenty-second timeout and no retry. Reads the addressed row from the caller org\'s own namespaced store. An id that is not there is 404 — and another tenant\'s id is not there by construction, so it reads exactly like a typo instead of confirming the row exists somewhere else. The token must carry the ADMIN permission; an ordinary access token is refused. The per-kind permission table has no entry for webhook, so the scaffold skips that second check with a warning and the gate above is the whole authorization story.
|
|
8936
|
-
* @summary Fetch one webhook
|
|
8937
|
-
* @param {CommerceApiGetCommerceWebhookByWebhookidRequest} requestParameters Request parameters.
|
|
8938
|
-
* @param {*} [options] Override http request option.
|
|
8939
|
-
* @throws {RequiredError}
|
|
8940
|
-
*/
|
|
8941
|
-
getCommerceWebhookByWebhookid(requestParameters: CommerceApiGetCommerceWebhookByWebhookidRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
8942
|
-
return localVarFp.getCommerceWebhookByWebhookid(requestParameters.webhookid, options).then((request) => request(axios, basePath));
|
|
8943
|
-
},
|
|
8944
8568
|
/**
|
|
8945
8569
|
* Opens an empty cart for a shopper to fill, and answers it with its new id. This is the first step of a sale: hold the id, add items to it with setCartItem, then hand it to checkout. Every field of the request is optional — an empty body opens a perfectly good anonymous cart — and the fields exist only to pre-fill what is already known about the shopper. The STORE defaults to the org\'s own default storefront, so a merchant selling through one storefront never has to name it. The CURRENCY defaults to usd; note that checkout overrides it with the store\'s own currency when the sale is authorized, so a currency set here is a hint rather than a commitment. The cart is created in the CALLER\'S OWN org namespace, taken from the validated principal and never from the body, so a cart can never be opened on another tenant\'s books. A named handler, not a closure, so zipdoc can lift this prose into the registry.
|
|
8946
8570
|
* @summary Open a cart for a shopper to fill
|
|
@@ -9131,16 +8755,6 @@ export const CommerceApiFactory = function (configuration?: Configuration, baseP
|
|
|
9131
8755
|
patchCommerceWatchlistByWatchlistid(requestParameters: CommerceApiPatchCommerceWatchlistByWatchlistidRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
9132
8756
|
return localVarFp.patchCommerceWatchlistByWatchlistid(requestParameters.watchlistid, options).then((request) => request(axios, basePath));
|
|
9133
8757
|
},
|
|
9134
|
-
/**
|
|
9135
|
-
* A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY. Two things to know before registering one: that token is a plainly readable field, so anyone who may read webhooks reads every endpoint\'s secret, and delivery consults only the all flag and the event map — it does NOT consult enabled or live, so setting enabled false does not stop delivery and deleting the row is the only thing that does. Delivery is a single POST with a twenty-second timeout and no retry. Loads the stored row and decodes the body OVER it, so only the fields the body names change and everything else keeps its stored value — the difference from the full replace, which clears what it is not told. Answers the merged row. An id absent from the caller org\'s namespace is 404 and a body that fails to decode is 400. The token must carry the ADMIN permission; an ordinary access token is refused. The per-kind permission table has no entry for webhook, so the scaffold skips that second check with a warning and the gate above is the whole authorization story.
|
|
9136
|
-
* @summary Change part of a webhook
|
|
9137
|
-
* @param {CommerceApiPatchCommerceWebhookByWebhookidRequest} requestParameters Request parameters.
|
|
9138
|
-
* @param {*} [options] Override http request option.
|
|
9139
|
-
* @throws {RequiredError}
|
|
9140
|
-
*/
|
|
9141
|
-
patchCommerceWebhookByWebhookid(requestParameters: CommerceApiPatchCommerceWebhookByWebhookidRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
9142
|
-
return localVarFp.patchCommerceWebhookByWebhookid(requestParameters.webhookid, options).then((request) => request(axios, basePath));
|
|
9143
|
-
},
|
|
9144
8758
|
/**
|
|
9145
8759
|
* Takes a batch of model rows and upserts each one\'s upstream COST and machine-observable facts, answering what was created and changed. It deliberately touches nothing a human owns — not the retail price, not the markup, not the entitlement tier — so a sync can never overwrite an administrator\'s pricing decision. The gate is a PLATFORM principal rather than a platform ADMIN, because the caller is normally a scheduled job — the platform\'s own application, an IAM identity under the admin org.
|
|
9146
8760
|
* @summary Land a syncer\'s view of the model catalog: upstream costs and machine facts
|
|
@@ -9652,26 +9266,7 @@ export const CommerceApiFactory = function (configuration?: Configuration, baseP
|
|
|
9652
9266
|
return localVarFp.postCommerceWatchlistByWatchlistid(requestParameters.watchlistid, options).then((request) => request(axios, basePath));
|
|
9653
9267
|
},
|
|
9654
9268
|
/**
|
|
9655
|
-
*
|
|
9656
|
-
* @summary Create a webhook
|
|
9657
|
-
* @param {*} [options] Override http request option.
|
|
9658
|
-
* @throws {RequiredError}
|
|
9659
|
-
*/
|
|
9660
|
-
postCommerceWebhook(options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
9661
|
-
return localVarFp.postCommerceWebhook(options).then((request) => request(axios, basePath));
|
|
9662
|
-
},
|
|
9663
|
-
/**
|
|
9664
|
-
* A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY. Two things to know before registering one: that token is a plainly readable field, so anyone who may read webhooks reads every endpoint\'s secret, and delivery consults only the all flag and the event map — it does NOT consult enabled or live, so setting enabled false does not stop delivery and deleting the row is the only thing that does. Delivery is a single POST with a twenty-second timeout and no retry. Re-dispatches the request into the handler the intended verb would have reached, taking that verb from a _method form value or query parameter and then from the X-HTTP-Method-Override header. PUT replaces the row, PATCH changes part of it, DELETE removes it, and anything else is 405. The trap is the DEFAULT: naming no override at all leaves the method POST, which this tunnel maps to the PARTIAL UPDATE — it is never a create, and creating is the collection root\'s job. Behaviour and authorization are the underlying operation\'s, since the real handler runs. The token must carry the ADMIN permission; an ordinary access token is refused.
|
|
9665
|
-
* @summary Method-override tunnel for a webhook — for clients that cannot send PUT, PATCH or DELETE
|
|
9666
|
-
* @param {CommerceApiPostCommerceWebhookByWebhookidRequest} requestParameters Request parameters.
|
|
9667
|
-
* @param {*} [options] Override http request option.
|
|
9668
|
-
* @throws {RequiredError}
|
|
9669
|
-
*/
|
|
9670
|
-
postCommerceWebhookByWebhookid(requestParameters: CommerceApiPostCommerceWebhookByWebhookidRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
9671
|
-
return localVarFp.postCommerceWebhookByWebhookid(requestParameters.webhookid, options).then((request) => request(axios, basePath));
|
|
9672
|
-
},
|
|
9673
|
-
/**
|
|
9674
|
-
* Accepts a payment provider\'s event, verifies it, records it for audit, and applies subscription lifecycle changes to the matching local row. There is no bearer here and there cannot be: the provider\'s SIGNATURE over the body IS the authentication, so a request with no recognized signature header is 400 and one whose signature does not verify is 401. The provider path segment is only a hint for dashboard configuration — verification picks the processor regardless of what the URL says. Redelivery is safe: an event id already recorded is acknowledged as a duplicate without re-applying any side effect, which matters because providers retry for days until they see a 2xx.
|
|
9269
|
+
* Accepts a payment provider\'s event, verifies it, applies its settlement, refund, dispute and subscription effects, and records it for audit. There is no bearer here and there cannot be: the provider\'s SIGNATURE over the body IS the authentication, so a request with no recognized signature header is 400 and one whose signature does not verify is 401. The path names the one processor that verifies, and only a processor holding its webhook secret may; any other name is 401. Each event is applied once for the whole deployment: a redelivery of an applied event is acknowledged as a duplicate, one still being applied is 409, and an event whose effect could not land is 503 so the provider redelivers it.
|
|
9675
9270
|
* @summary Payment-provider webhook intake for settlement and subscription lifecycle events
|
|
9676
9271
|
* @param {CommerceApiPostCommerceWebhooksByProviderRequest} requestParameters Request parameters.
|
|
9677
9272
|
* @param {*} [options] Override http request option.
|
|
@@ -9860,16 +9455,6 @@ export const CommerceApiFactory = function (configuration?: Configuration, baseP
|
|
|
9860
9455
|
putCommerceWatchlistByWatchlistid(requestParameters: CommerceApiPutCommerceWatchlistByWatchlistidRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
9861
9456
|
return localVarFp.putCommerceWatchlistByWatchlistid(requestParameters.watchlistid, options).then((request) => request(axios, basePath));
|
|
9862
9457
|
},
|
|
9863
|
-
/**
|
|
9864
|
-
* A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY. Two things to know before registering one: that token is a plainly readable field, so anyone who may read webhooks reads every endpoint\'s secret, and delivery consults only the all flag and the event map — it does NOT consult enabled or live, so setting enabled false does not stop delivery and deleting the row is the only thing that does. Delivery is a single POST with a twenty-second timeout and no retry. This is a true REPLACEMENT, not a merge: the stored row\'s key is preserved, but the body is decoded onto a FRESH entity, so every field the body omits is written back as its ZERO value. Patch is the verb for changing part of a row. The id is resolved inside the caller org\'s own namespace and an absent one is 404 before anything is written; a body that fails to decode is 400. Answers the stored result. The token must carry the ADMIN permission; an ordinary access token is refused. The per-kind permission table has no entry for webhook, so the scaffold skips that second check with a warning and the gate above is the whole authorization story.
|
|
9865
|
-
* @summary Replace a webhook outright
|
|
9866
|
-
* @param {CommerceApiPutCommerceWebhookByWebhookidRequest} requestParameters Request parameters.
|
|
9867
|
-
* @param {*} [options] Override http request option.
|
|
9868
|
-
* @throws {RequiredError}
|
|
9869
|
-
*/
|
|
9870
|
-
putCommerceWebhookByWebhookid(requestParameters: CommerceApiPutCommerceWebhookByWebhookidRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
9871
|
-
return localVarFp.putCommerceWebhookByWebhookid(requestParameters.webhookid, options).then((request) => request(axios, basePath));
|
|
9872
|
-
},
|
|
9873
9458
|
/**
|
|
9874
9459
|
* Sets how many of one item a cart holds, and answers the whole updated cart. This is the ONE way a cart\'s contents change. The quantity is the RESULT, not a delta: sending 3 leaves 3 however many were there before, so a retry is safe and a double-submit cannot double an order. ZERO REMOVES the line — there is deliberately no separate delete, because removal is the same act at the boundary value and a second spelling would be a second set of edge cases. Name the item with EITHER product OR variant, never both. Prefer variant for anything sold in sizes, colours or tiers: the price and the stock belong to the variant, so a product-level line on a varianted product prices the wrong thing. Either may be given as an id or as the human key — a product\'s URL slug, a variant\'s SKU — which is what lets a storefront add to cart straight from a product page URL without a lookup first. The item\'s price and name are CACHED onto the line as it is added, so the cart keeps the price the shopper was shown even if the catalog moves underneath it. An item that resolves to nothing in the catalog is refused 400 and the cart is left exactly as it was; nothing is partially applied. A named handler, not a closure, so zipdoc can lift this prose into the registry.
|
|
9875
9460
|
* @summary Set one item\'s quantity in a cart; zero removes it
|
|
@@ -10142,20 +9727,6 @@ export interface CommerceApiDeleteCommerceWatchlistByWatchlistidRequest {
|
|
|
10142
9727
|
readonly watchlistid: string
|
|
10143
9728
|
}
|
|
10144
9729
|
|
|
10145
|
-
/**
|
|
10146
|
-
* Request parameters for deleteCommerceWebhookByWebhookid operation in CommerceApi.
|
|
10147
|
-
* @export
|
|
10148
|
-
* @interface CommerceApiDeleteCommerceWebhookByWebhookidRequest
|
|
10149
|
-
*/
|
|
10150
|
-
export interface CommerceApiDeleteCommerceWebhookByWebhookidRequest {
|
|
10151
|
-
/**
|
|
10152
|
-
*
|
|
10153
|
-
* @type {string}
|
|
10154
|
-
* @memberof CommerceApiDeleteCommerceWebhookByWebhookid
|
|
10155
|
-
*/
|
|
10156
|
-
readonly webhookid: string
|
|
10157
|
-
}
|
|
10158
|
-
|
|
10159
9730
|
/**
|
|
10160
9731
|
* Request parameters for discardCart operation in CommerceApi.
|
|
10161
9732
|
* @export
|
|
@@ -10520,20 +10091,6 @@ export interface CommerceApiGetCommerceWatchlistByWatchlistidRequest {
|
|
|
10520
10091
|
readonly watchlistid: string
|
|
10521
10092
|
}
|
|
10522
10093
|
|
|
10523
|
-
/**
|
|
10524
|
-
* Request parameters for getCommerceWebhookByWebhookid operation in CommerceApi.
|
|
10525
|
-
* @export
|
|
10526
|
-
* @interface CommerceApiGetCommerceWebhookByWebhookidRequest
|
|
10527
|
-
*/
|
|
10528
|
-
export interface CommerceApiGetCommerceWebhookByWebhookidRequest {
|
|
10529
|
-
/**
|
|
10530
|
-
*
|
|
10531
|
-
* @type {string}
|
|
10532
|
-
* @memberof CommerceApiGetCommerceWebhookByWebhookid
|
|
10533
|
-
*/
|
|
10534
|
-
readonly webhookid: string
|
|
10535
|
-
}
|
|
10536
|
-
|
|
10537
10094
|
/**
|
|
10538
10095
|
* Request parameters for openCart operation in CommerceApi.
|
|
10539
10096
|
* @export
|
|
@@ -10807,20 +10364,6 @@ export interface CommerceApiPatchCommerceWatchlistByWatchlistidRequest {
|
|
|
10807
10364
|
readonly watchlistid: string
|
|
10808
10365
|
}
|
|
10809
10366
|
|
|
10810
|
-
/**
|
|
10811
|
-
* Request parameters for patchCommerceWebhookByWebhookid operation in CommerceApi.
|
|
10812
|
-
* @export
|
|
10813
|
-
* @interface CommerceApiPatchCommerceWebhookByWebhookidRequest
|
|
10814
|
-
*/
|
|
10815
|
-
export interface CommerceApiPatchCommerceWebhookByWebhookidRequest {
|
|
10816
|
-
/**
|
|
10817
|
-
*
|
|
10818
|
-
* @type {string}
|
|
10819
|
-
* @memberof CommerceApiPatchCommerceWebhookByWebhookid
|
|
10820
|
-
*/
|
|
10821
|
-
readonly webhookid: string
|
|
10822
|
-
}
|
|
10823
|
-
|
|
10824
10367
|
/**
|
|
10825
10368
|
* Request parameters for postCommerceCollectionByCollectionid operation in CommerceApi.
|
|
10826
10369
|
* @export
|
|
@@ -11346,20 +10889,6 @@ export interface CommerceApiPostCommerceWatchlistByWatchlistidRequest {
|
|
|
11346
10889
|
readonly watchlistid: string
|
|
11347
10890
|
}
|
|
11348
10891
|
|
|
11349
|
-
/**
|
|
11350
|
-
* Request parameters for postCommerceWebhookByWebhookid operation in CommerceApi.
|
|
11351
|
-
* @export
|
|
11352
|
-
* @interface CommerceApiPostCommerceWebhookByWebhookidRequest
|
|
11353
|
-
*/
|
|
11354
|
-
export interface CommerceApiPostCommerceWebhookByWebhookidRequest {
|
|
11355
|
-
/**
|
|
11356
|
-
*
|
|
11357
|
-
* @type {string}
|
|
11358
|
-
* @memberof CommerceApiPostCommerceWebhookByWebhookid
|
|
11359
|
-
*/
|
|
11360
|
-
readonly webhookid: string
|
|
11361
|
-
}
|
|
11362
|
-
|
|
11363
10892
|
/**
|
|
11364
10893
|
* Request parameters for postCommerceWebhooksByProvider operation in CommerceApi.
|
|
11365
10894
|
* @export
|
|
@@ -11633,20 +11162,6 @@ export interface CommerceApiPutCommerceWatchlistByWatchlistidRequest {
|
|
|
11633
11162
|
readonly watchlistid: string
|
|
11634
11163
|
}
|
|
11635
11164
|
|
|
11636
|
-
/**
|
|
11637
|
-
* Request parameters for putCommerceWebhookByWebhookid operation in CommerceApi.
|
|
11638
|
-
* @export
|
|
11639
|
-
* @interface CommerceApiPutCommerceWebhookByWebhookidRequest
|
|
11640
|
-
*/
|
|
11641
|
-
export interface CommerceApiPutCommerceWebhookByWebhookidRequest {
|
|
11642
|
-
/**
|
|
11643
|
-
*
|
|
11644
|
-
* @type {string}
|
|
11645
|
-
* @memberof CommerceApiPutCommerceWebhookByWebhookid
|
|
11646
|
-
*/
|
|
11647
|
-
readonly webhookid: string
|
|
11648
|
-
}
|
|
11649
|
-
|
|
11650
11165
|
/**
|
|
11651
11166
|
* Request parameters for setCartItem operation in CommerceApi.
|
|
11652
11167
|
* @export
|
|
@@ -11891,18 +11406,6 @@ export class CommerceApi extends BaseAPI {
|
|
|
11891
11406
|
return CommerceApiFp(this.configuration).deleteCommerceWatchlistByWatchlistid(requestParameters.watchlistid, options).then((request) => request(this.axios, this.basePath));
|
|
11892
11407
|
}
|
|
11893
11408
|
|
|
11894
|
-
/**
|
|
11895
|
-
* A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY. Two things to know before registering one: that token is a plainly readable field, so anyone who may read webhooks reads every endpoint\'s secret, and delivery consults only the all flag and the event map — it does NOT consult enabled or live, so setting enabled false does not stop delivery and deleting the row is the only thing that does. Delivery is a single POST with a twenty-second timeout and no retry. Removes the addressed row and answers 204 with no body. Before the live row goes it is written once more under a deleted tombstone kind, so a deletion leaves a recoverable copy rather than destroying the record outright — and a tombstone that cannot be written fails the call with 500 before anything is removed. The id is resolved inside the caller org\'s own namespace, so an absent or foreign id is 404. The token must carry the ADMIN permission; an ordinary access token is refused. The per-kind permission table has no entry for webhook, so the scaffold skips that second check with a warning and the gate above is the whole authorization story.
|
|
11896
|
-
* @summary Delete a webhook, keeping a recoverable copy
|
|
11897
|
-
* @param {CommerceApiDeleteCommerceWebhookByWebhookidRequest} requestParameters Request parameters.
|
|
11898
|
-
* @param {*} [options] Override http request option.
|
|
11899
|
-
* @throws {RequiredError}
|
|
11900
|
-
* @memberof CommerceApi
|
|
11901
|
-
*/
|
|
11902
|
-
public deleteCommerceWebhookByWebhookid(requestParameters: CommerceApiDeleteCommerceWebhookByWebhookidRequest, options?: RawAxiosRequestConfig) {
|
|
11903
|
-
return CommerceApiFp(this.configuration).deleteCommerceWebhookByWebhookid(requestParameters.webhookid, options).then((request) => request(this.axios, this.basePath));
|
|
11904
|
-
}
|
|
11905
|
-
|
|
11906
11409
|
/**
|
|
11907
11410
|
* Discards a cart the shopper abandoned, and answers it in its final state. A discarded cart is CLOSED, not deleted: the row stays, so abandoned-basket reporting and any follow-up that keys on it still have something to read. It stops being a cart anything will check out, which is the point — it is how a storefront says \"this basket is over\" without destroying the evidence that it existed. Discarding is idempotent: a cart already discarded answers its stored state rather than failing, so a retry is safe. The cart is resolved inside the caller\'s own org namespace, so another tenant\'s id answers 404. A named handler, not a closure, so zipdoc can lift this prose into the registry.
|
|
11908
11411
|
* @summary Discard a cart the shopper abandoned
|
|
@@ -12444,29 +11947,6 @@ export class CommerceApi extends BaseAPI {
|
|
|
12444
11947
|
return CommerceApiFp(this.configuration).getCommerceWatchlistByWatchlistid(requestParameters.watchlistid, options).then((request) => request(this.axios, this.basePath));
|
|
12445
11948
|
}
|
|
12446
11949
|
|
|
12447
|
-
/**
|
|
12448
|
-
* A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY. Two things to know before registering one: that token is a plainly readable field, so anyone who may read webhooks reads every endpoint\'s secret, and delivery consults only the all flag and the event map — it does NOT consult enabled or live, so setting enabled false does not stop delivery and deleting the row is the only thing that does. Delivery is a single POST with a twenty-second timeout and no retry. Answers a pagination envelope — the page and display echoed back, the rows under models, a total count and a facets array — read from the caller org\'s own namespaced store, so one tenant can never list another\'s. Sorting defaults to the last-updated time and is overridable with sort. display is the page size and page applies only alongside it; either one that is not a positive integer is refused with 500 rather than silently ignored, and the limit query overrides the reported COUNT only, never the rows returned. No search backend is wired, so the datastore is the one and only list path and facets is always empty. A request resolving no org namespace is served an EMPTY page rather than an unscoped scan: the namespace IS the tenant filter, so without one there is nothing safe to return. The token must carry the ADMIN permission; an ordinary access token is refused. The per-kind permission table has no entry for webhook, so the scaffold skips that second check with a warning and the gate above is the whole authorization story.
|
|
12449
|
-
* @summary List your org\'s webhooks, as a page
|
|
12450
|
-
* @param {*} [options] Override http request option.
|
|
12451
|
-
* @throws {RequiredError}
|
|
12452
|
-
* @memberof CommerceApi
|
|
12453
|
-
*/
|
|
12454
|
-
public getCommerceWebhook(options?: RawAxiosRequestConfig) {
|
|
12455
|
-
return CommerceApiFp(this.configuration).getCommerceWebhook(options).then((request) => request(this.axios, this.basePath));
|
|
12456
|
-
}
|
|
12457
|
-
|
|
12458
|
-
/**
|
|
12459
|
-
* A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY. Two things to know before registering one: that token is a plainly readable field, so anyone who may read webhooks reads every endpoint\'s secret, and delivery consults only the all flag and the event map — it does NOT consult enabled or live, so setting enabled false does not stop delivery and deleting the row is the only thing that does. Delivery is a single POST with a twenty-second timeout and no retry. Reads the addressed row from the caller org\'s own namespaced store. An id that is not there is 404 — and another tenant\'s id is not there by construction, so it reads exactly like a typo instead of confirming the row exists somewhere else. The token must carry the ADMIN permission; an ordinary access token is refused. The per-kind permission table has no entry for webhook, so the scaffold skips that second check with a warning and the gate above is the whole authorization story.
|
|
12460
|
-
* @summary Fetch one webhook
|
|
12461
|
-
* @param {CommerceApiGetCommerceWebhookByWebhookidRequest} requestParameters Request parameters.
|
|
12462
|
-
* @param {*} [options] Override http request option.
|
|
12463
|
-
* @throws {RequiredError}
|
|
12464
|
-
* @memberof CommerceApi
|
|
12465
|
-
*/
|
|
12466
|
-
public getCommerceWebhookByWebhookid(requestParameters: CommerceApiGetCommerceWebhookByWebhookidRequest, options?: RawAxiosRequestConfig) {
|
|
12467
|
-
return CommerceApiFp(this.configuration).getCommerceWebhookByWebhookid(requestParameters.webhookid, options).then((request) => request(this.axios, this.basePath));
|
|
12468
|
-
}
|
|
12469
|
-
|
|
12470
11950
|
/**
|
|
12471
11951
|
* Opens an empty cart for a shopper to fill, and answers it with its new id. This is the first step of a sale: hold the id, add items to it with setCartItem, then hand it to checkout. Every field of the request is optional — an empty body opens a perfectly good anonymous cart — and the fields exist only to pre-fill what is already known about the shopper. The STORE defaults to the org\'s own default storefront, so a merchant selling through one storefront never has to name it. The CURRENCY defaults to usd; note that checkout overrides it with the store\'s own currency when the sale is authorized, so a currency set here is a hint rather than a commitment. The cart is created in the CALLER\'S OWN org namespace, taken from the validated principal and never from the body, so a cart can never be opened on another tenant\'s books. A named handler, not a closure, so zipdoc can lift this prose into the registry.
|
|
12472
11952
|
* @summary Open a cart for a shopper to fill
|
|
@@ -12695,18 +12175,6 @@ export class CommerceApi extends BaseAPI {
|
|
|
12695
12175
|
return CommerceApiFp(this.configuration).patchCommerceWatchlistByWatchlistid(requestParameters.watchlistid, options).then((request) => request(this.axios, this.basePath));
|
|
12696
12176
|
}
|
|
12697
12177
|
|
|
12698
|
-
/**
|
|
12699
|
-
* A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY. Two things to know before registering one: that token is a plainly readable field, so anyone who may read webhooks reads every endpoint\'s secret, and delivery consults only the all flag and the event map — it does NOT consult enabled or live, so setting enabled false does not stop delivery and deleting the row is the only thing that does. Delivery is a single POST with a twenty-second timeout and no retry. Loads the stored row and decodes the body OVER it, so only the fields the body names change and everything else keeps its stored value — the difference from the full replace, which clears what it is not told. Answers the merged row. An id absent from the caller org\'s namespace is 404 and a body that fails to decode is 400. The token must carry the ADMIN permission; an ordinary access token is refused. The per-kind permission table has no entry for webhook, so the scaffold skips that second check with a warning and the gate above is the whole authorization story.
|
|
12700
|
-
* @summary Change part of a webhook
|
|
12701
|
-
* @param {CommerceApiPatchCommerceWebhookByWebhookidRequest} requestParameters Request parameters.
|
|
12702
|
-
* @param {*} [options] Override http request option.
|
|
12703
|
-
* @throws {RequiredError}
|
|
12704
|
-
* @memberof CommerceApi
|
|
12705
|
-
*/
|
|
12706
|
-
public patchCommerceWebhookByWebhookid(requestParameters: CommerceApiPatchCommerceWebhookByWebhookidRequest, options?: RawAxiosRequestConfig) {
|
|
12707
|
-
return CommerceApiFp(this.configuration).patchCommerceWebhookByWebhookid(requestParameters.webhookid, options).then((request) => request(this.axios, this.basePath));
|
|
12708
|
-
}
|
|
12709
|
-
|
|
12710
12178
|
/**
|
|
12711
12179
|
* Takes a batch of model rows and upserts each one\'s upstream COST and machine-observable facts, answering what was created and changed. It deliberately touches nothing a human owns — not the retail price, not the markup, not the entitlement tier — so a sync can never overwrite an administrator\'s pricing decision. The gate is a PLATFORM principal rather than a platform ADMIN, because the caller is normally a scheduled job — the platform\'s own application, an IAM identity under the admin org.
|
|
12712
12180
|
* @summary Land a syncer\'s view of the model catalog: upstream costs and machine facts
|
|
@@ -13324,30 +12792,7 @@ export class CommerceApi extends BaseAPI {
|
|
|
13324
12792
|
}
|
|
13325
12793
|
|
|
13326
12794
|
/**
|
|
13327
|
-
*
|
|
13328
|
-
* @summary Create a webhook
|
|
13329
|
-
* @param {*} [options] Override http request option.
|
|
13330
|
-
* @throws {RequiredError}
|
|
13331
|
-
* @memberof CommerceApi
|
|
13332
|
-
*/
|
|
13333
|
-
public postCommerceWebhook(options?: RawAxiosRequestConfig) {
|
|
13334
|
-
return CommerceApiFp(this.configuration).postCommerceWebhook(options).then((request) => request(this.axios, this.basePath));
|
|
13335
|
-
}
|
|
13336
|
-
|
|
13337
|
-
/**
|
|
13338
|
-
* A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY. Two things to know before registering one: that token is a plainly readable field, so anyone who may read webhooks reads every endpoint\'s secret, and delivery consults only the all flag and the event map — it does NOT consult enabled or live, so setting enabled false does not stop delivery and deleting the row is the only thing that does. Delivery is a single POST with a twenty-second timeout and no retry. Re-dispatches the request into the handler the intended verb would have reached, taking that verb from a _method form value or query parameter and then from the X-HTTP-Method-Override header. PUT replaces the row, PATCH changes part of it, DELETE removes it, and anything else is 405. The trap is the DEFAULT: naming no override at all leaves the method POST, which this tunnel maps to the PARTIAL UPDATE — it is never a create, and creating is the collection root\'s job. Behaviour and authorization are the underlying operation\'s, since the real handler runs. The token must carry the ADMIN permission; an ordinary access token is refused.
|
|
13339
|
-
* @summary Method-override tunnel for a webhook — for clients that cannot send PUT, PATCH or DELETE
|
|
13340
|
-
* @param {CommerceApiPostCommerceWebhookByWebhookidRequest} requestParameters Request parameters.
|
|
13341
|
-
* @param {*} [options] Override http request option.
|
|
13342
|
-
* @throws {RequiredError}
|
|
13343
|
-
* @memberof CommerceApi
|
|
13344
|
-
*/
|
|
13345
|
-
public postCommerceWebhookByWebhookid(requestParameters: CommerceApiPostCommerceWebhookByWebhookidRequest, options?: RawAxiosRequestConfig) {
|
|
13346
|
-
return CommerceApiFp(this.configuration).postCommerceWebhookByWebhookid(requestParameters.webhookid, options).then((request) => request(this.axios, this.basePath));
|
|
13347
|
-
}
|
|
13348
|
-
|
|
13349
|
-
/**
|
|
13350
|
-
* Accepts a payment provider\'s event, verifies it, records it for audit, and applies subscription lifecycle changes to the matching local row. There is no bearer here and there cannot be: the provider\'s SIGNATURE over the body IS the authentication, so a request with no recognized signature header is 400 and one whose signature does not verify is 401. The provider path segment is only a hint for dashboard configuration — verification picks the processor regardless of what the URL says. Redelivery is safe: an event id already recorded is acknowledged as a duplicate without re-applying any side effect, which matters because providers retry for days until they see a 2xx.
|
|
12795
|
+
* Accepts a payment provider\'s event, verifies it, applies its settlement, refund, dispute and subscription effects, and records it for audit. There is no bearer here and there cannot be: the provider\'s SIGNATURE over the body IS the authentication, so a request with no recognized signature header is 400 and one whose signature does not verify is 401. The path names the one processor that verifies, and only a processor holding its webhook secret may; any other name is 401. Each event is applied once for the whole deployment: a redelivery of an applied event is acknowledged as a duplicate, one still being applied is 409, and an event whose effect could not land is 503 so the provider redelivers it.
|
|
13351
12796
|
* @summary Payment-provider webhook intake for settlement and subscription lifecycle events
|
|
13352
12797
|
* @param {CommerceApiPostCommerceWebhooksByProviderRequest} requestParameters Request parameters.
|
|
13353
12798
|
* @param {*} [options] Override http request option.
|
|
@@ -13574,18 +13019,6 @@ export class CommerceApi extends BaseAPI {
|
|
|
13574
13019
|
return CommerceApiFp(this.configuration).putCommerceWatchlistByWatchlistid(requestParameters.watchlistid, options).then((request) => request(this.axios, this.basePath));
|
|
13575
13020
|
}
|
|
13576
13021
|
|
|
13577
|
-
/**
|
|
13578
|
-
* A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY. Two things to know before registering one: that token is a plainly readable field, so anyone who may read webhooks reads every endpoint\'s secret, and delivery consults only the all flag and the event map — it does NOT consult enabled or live, so setting enabled false does not stop delivery and deleting the row is the only thing that does. Delivery is a single POST with a twenty-second timeout and no retry. This is a true REPLACEMENT, not a merge: the stored row\'s key is preserved, but the body is decoded onto a FRESH entity, so every field the body omits is written back as its ZERO value. Patch is the verb for changing part of a row. The id is resolved inside the caller org\'s own namespace and an absent one is 404 before anything is written; a body that fails to decode is 400. Answers the stored result. The token must carry the ADMIN permission; an ordinary access token is refused. The per-kind permission table has no entry for webhook, so the scaffold skips that second check with a warning and the gate above is the whole authorization story.
|
|
13579
|
-
* @summary Replace a webhook outright
|
|
13580
|
-
* @param {CommerceApiPutCommerceWebhookByWebhookidRequest} requestParameters Request parameters.
|
|
13581
|
-
* @param {*} [options] Override http request option.
|
|
13582
|
-
* @throws {RequiredError}
|
|
13583
|
-
* @memberof CommerceApi
|
|
13584
|
-
*/
|
|
13585
|
-
public putCommerceWebhookByWebhookid(requestParameters: CommerceApiPutCommerceWebhookByWebhookidRequest, options?: RawAxiosRequestConfig) {
|
|
13586
|
-
return CommerceApiFp(this.configuration).putCommerceWebhookByWebhookid(requestParameters.webhookid, options).then((request) => request(this.axios, this.basePath));
|
|
13587
|
-
}
|
|
13588
|
-
|
|
13589
13022
|
/**
|
|
13590
13023
|
* Sets how many of one item a cart holds, and answers the whole updated cart. This is the ONE way a cart\'s contents change. The quantity is the RESULT, not a delta: sending 3 leaves 3 however many were there before, so a retry is safe and a double-submit cannot double an order. ZERO REMOVES the line — there is deliberately no separate delete, because removal is the same act at the boundary value and a second spelling would be a second set of edge cases. Name the item with EITHER product OR variant, never both. Prefer variant for anything sold in sizes, colours or tiers: the price and the stock belong to the variant, so a product-level line on a varianted product prices the wrong thing. Either may be given as an id or as the human key — a product\'s URL slug, a variant\'s SKU — which is what lets a storefront add to cart straight from a product page URL without a lookup first. The item\'s price and name are CACHED onto the line as it is added, so the cart keeps the price the shopper was shown even if the catalog moves underneath it. An item that resolves to nothing in the catalog is refused 400 and the cart is left exactly as it was; nothing is partially applied. A named handler, not a closure, so zipdoc can lift this prose into the registry.
|
|
13591
13024
|
* @summary Set one item\'s quantity in a cart; zero removes it
|