@blezgo/api-sdk 0.1.0 → 0.1.1
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/CHANGELOG.md +1 -1
- package/dist/account/generated.d.ts +211 -211
- package/dist/account/generated.d.ts.map +1 -1
- package/dist/activity/client.d.ts +3 -0
- package/dist/activity/client.d.ts.map +1 -0
- package/dist/activity/client.js +3 -0
- package/dist/activity/client.js.map +1 -0
- package/dist/activity/generated.d.ts +1754 -0
- package/dist/activity/generated.d.ts.map +1 -0
- package/dist/activity/generated.js +6 -0
- package/dist/activity/generated.js.map +1 -0
- package/dist/activity/index.d.ts +2 -0
- package/dist/activity/index.d.ts.map +1 -0
- package/dist/activity/index.js +2 -0
- package/dist/activity/index.js.map +1 -0
- package/dist/addon/client.d.ts +3 -0
- package/dist/addon/client.d.ts.map +1 -0
- package/dist/addon/client.js +3 -0
- package/dist/addon/client.js.map +1 -0
- package/dist/addon/generated.d.ts +4750 -0
- package/dist/addon/generated.d.ts.map +1 -0
- package/dist/addon/generated.js +6 -0
- package/dist/addon/generated.js.map +1 -0
- package/dist/addon/index.d.ts +2 -0
- package/dist/addon/index.d.ts.map +1 -0
- package/dist/addon/index.js +2 -0
- package/dist/addon/index.js.map +1 -0
- package/dist/admin/generated.d.ts +104 -104
- package/dist/admin/generated.d.ts.map +1 -1
- package/dist/affiliate/client.d.ts +3 -0
- package/dist/affiliate/client.d.ts.map +1 -0
- package/dist/affiliate/client.js +3 -0
- package/dist/affiliate/client.js.map +1 -0
- package/dist/affiliate/generated.d.ts +4785 -0
- package/dist/affiliate/generated.d.ts.map +1 -0
- package/dist/affiliate/generated.js +6 -0
- package/dist/affiliate/generated.js.map +1 -0
- package/dist/affiliate/index.d.ts +2 -0
- package/dist/affiliate/index.d.ts.map +1 -0
- package/dist/affiliate/index.js +2 -0
- package/dist/affiliate/index.js.map +1 -0
- package/dist/analytics/client.d.ts +3 -0
- package/dist/analytics/client.d.ts.map +1 -0
- package/dist/analytics/client.js +3 -0
- package/dist/analytics/client.js.map +1 -0
- package/dist/analytics/generated.d.ts +1566 -0
- package/dist/analytics/generated.d.ts.map +1 -0
- package/dist/analytics/generated.js +6 -0
- package/dist/analytics/generated.js.map +1 -0
- package/dist/analytics/index.d.ts +2 -0
- package/dist/analytics/index.d.ts.map +1 -0
- package/dist/analytics/index.js +2 -0
- package/dist/analytics/index.js.map +1 -0
- package/dist/announcements/client.d.ts +3 -0
- package/dist/announcements/client.d.ts.map +1 -0
- package/dist/announcements/client.js +3 -0
- package/dist/announcements/client.js.map +1 -0
- package/dist/announcements/generated.d.ts +2922 -0
- package/dist/announcements/generated.d.ts.map +1 -0
- package/dist/announcements/generated.js +6 -0
- package/dist/announcements/generated.js.map +1 -0
- package/dist/announcements/index.d.ts +2 -0
- package/dist/announcements/index.d.ts.map +1 -0
- package/dist/announcements/index.js +2 -0
- package/dist/announcements/index.js.map +1 -0
- package/dist/apikeys/client.d.ts +3 -0
- package/dist/apikeys/client.d.ts.map +1 -0
- package/dist/apikeys/client.js +3 -0
- package/dist/apikeys/client.js.map +1 -0
- package/dist/apikeys/generated.d.ts +2053 -0
- package/dist/apikeys/generated.d.ts.map +1 -0
- package/dist/apikeys/generated.js +6 -0
- package/dist/apikeys/generated.js.map +1 -0
- package/dist/apikeys/index.d.ts +2 -0
- package/dist/apikeys/index.d.ts.map +1 -0
- package/dist/apikeys/index.js +2 -0
- package/dist/apikeys/index.js.map +1 -0
- package/dist/assistance/client.d.ts +3 -0
- package/dist/assistance/client.d.ts.map +1 -0
- package/dist/assistance/client.js +3 -0
- package/dist/assistance/client.js.map +1 -0
- package/dist/assistance/generated.d.ts +869 -0
- package/dist/assistance/generated.d.ts.map +1 -0
- package/dist/assistance/generated.js +6 -0
- package/dist/assistance/generated.js.map +1 -0
- package/dist/assistance/index.d.ts +2 -0
- package/dist/assistance/index.d.ts.map +1 -0
- package/dist/assistance/index.js +2 -0
- package/dist/assistance/index.js.map +1 -0
- package/dist/authentication/generated.d.ts +110 -110
- package/dist/authentication/generated.d.ts.map +1 -1
- package/dist/blog/client.d.ts +3 -0
- package/dist/blog/client.d.ts.map +1 -0
- package/dist/blog/client.js +3 -0
- package/dist/blog/client.js.map +1 -0
- package/dist/blog/generated.d.ts +12567 -0
- package/dist/blog/generated.d.ts.map +1 -0
- package/dist/blog/generated.js +6 -0
- package/dist/blog/generated.js.map +1 -0
- package/dist/blog/index.d.ts +2 -0
- package/dist/blog/index.d.ts.map +1 -0
- package/dist/blog/index.js +2 -0
- package/dist/blog/index.js.map +1 -0
- package/dist/bundle/client.d.ts +3 -0
- package/dist/bundle/client.d.ts.map +1 -0
- package/dist/bundle/client.js +3 -0
- package/dist/bundle/client.js.map +1 -0
- package/dist/bundle/generated.d.ts +2692 -0
- package/dist/bundle/generated.d.ts.map +1 -0
- package/dist/bundle/generated.js +6 -0
- package/dist/bundle/generated.js.map +1 -0
- package/dist/bundle/index.d.ts +2 -0
- package/dist/bundle/index.d.ts.map +1 -0
- package/dist/bundle/index.js +2 -0
- package/dist/bundle/index.js.map +1 -0
- package/dist/cache/generated.d.ts +13 -13
- package/dist/cache/generated.d.ts.map +1 -1
- package/dist/calendar/client.d.ts +3 -0
- package/dist/calendar/client.d.ts.map +1 -0
- package/dist/calendar/client.js +3 -0
- package/dist/calendar/client.js.map +1 -0
- package/dist/calendar/generated.d.ts +1895 -0
- package/dist/calendar/generated.d.ts.map +1 -0
- package/dist/calendar/generated.js +6 -0
- package/dist/calendar/generated.js.map +1 -0
- package/dist/calendar/index.d.ts +2 -0
- package/dist/calendar/index.d.ts.map +1 -0
- package/dist/calendar/index.js +2 -0
- package/dist/calendar/index.js.map +1 -0
- package/dist/campaigns/client.d.ts +3 -0
- package/dist/campaigns/client.d.ts.map +1 -0
- package/dist/campaigns/client.js +3 -0
- package/dist/campaigns/client.js.map +1 -0
- package/dist/campaigns/generated.d.ts +5465 -0
- package/dist/campaigns/generated.d.ts.map +1 -0
- package/dist/campaigns/generated.js +6 -0
- package/dist/campaigns/generated.js.map +1 -0
- package/dist/campaigns/index.d.ts +2 -0
- package/dist/campaigns/index.d.ts.map +1 -0
- package/dist/campaigns/index.js +2 -0
- package/dist/campaigns/index.js.map +1 -0
- package/dist/cart/client.d.ts +3 -0
- package/dist/cart/client.d.ts.map +1 -0
- package/dist/cart/client.js +3 -0
- package/dist/cart/client.js.map +1 -0
- package/dist/cart/generated.d.ts +1552 -0
- package/dist/cart/generated.d.ts.map +1 -0
- package/dist/cart/generated.js +6 -0
- package/dist/cart/generated.js.map +1 -0
- package/dist/cart/index.d.ts +2 -0
- package/dist/cart/index.d.ts.map +1 -0
- package/dist/cart/index.js +2 -0
- package/dist/cart/index.js.map +1 -0
- package/dist/changelog/client.d.ts +3 -0
- package/dist/changelog/client.d.ts.map +1 -0
- package/dist/changelog/client.js +3 -0
- package/dist/changelog/client.js.map +1 -0
- package/dist/changelog/generated.d.ts +5619 -0
- package/dist/changelog/generated.d.ts.map +1 -0
- package/dist/changelog/generated.js +6 -0
- package/dist/changelog/generated.js.map +1 -0
- package/dist/changelog/index.d.ts +2 -0
- package/dist/changelog/index.d.ts.map +1 -0
- package/dist/changelog/index.js +2 -0
- package/dist/changelog/index.js.map +1 -0
- package/dist/channel/client.d.ts +3 -0
- package/dist/channel/client.d.ts.map +1 -0
- package/dist/channel/client.js +3 -0
- package/dist/channel/client.js.map +1 -0
- package/dist/channel/generated.d.ts +7136 -0
- package/dist/channel/generated.d.ts.map +1 -0
- package/dist/channel/generated.js +6 -0
- package/dist/channel/generated.js.map +1 -0
- package/dist/channel/index.d.ts +2 -0
- package/dist/channel/index.d.ts.map +1 -0
- package/dist/channel/index.js +2 -0
- package/dist/channel/index.js.map +1 -0
- package/dist/company/client.d.ts +3 -0
- package/dist/company/client.d.ts.map +1 -0
- package/dist/company/client.js +3 -0
- package/dist/company/client.js.map +1 -0
- package/dist/company/generated.d.ts +3964 -0
- package/dist/company/generated.d.ts.map +1 -0
- package/dist/company/generated.js +6 -0
- package/dist/company/generated.js.map +1 -0
- package/dist/company/index.d.ts +2 -0
- package/dist/company/index.d.ts.map +1 -0
- package/dist/company/index.js +2 -0
- package/dist/company/index.js.map +1 -0
- package/dist/conference/client.d.ts +3 -0
- package/dist/conference/client.d.ts.map +1 -0
- package/dist/conference/client.js +3 -0
- package/dist/conference/client.js.map +1 -0
- package/dist/conference/generated.d.ts +2761 -0
- package/dist/conference/generated.d.ts.map +1 -0
- package/dist/conference/generated.js +6 -0
- package/dist/conference/generated.js.map +1 -0
- package/dist/conference/index.d.ts +2 -0
- package/dist/conference/index.d.ts.map +1 -0
- package/dist/conference/index.js +2 -0
- package/dist/conference/index.js.map +1 -0
- package/dist/config/generated.d.ts +62 -62
- package/dist/config/generated.d.ts.map +1 -1
- package/dist/content/client.d.ts +3 -0
- package/dist/content/client.d.ts.map +1 -0
- package/dist/content/client.js +3 -0
- package/dist/content/client.js.map +1 -0
- package/dist/content/generated.d.ts +17424 -0
- package/dist/content/generated.d.ts.map +1 -0
- package/dist/content/generated.js +6 -0
- package/dist/content/generated.js.map +1 -0
- package/dist/content/index.d.ts +2 -0
- package/dist/content/index.d.ts.map +1 -0
- package/dist/content/index.js +2 -0
- package/dist/content/index.js.map +1 -0
- package/dist/cookies/client.d.ts +3 -0
- package/dist/cookies/client.d.ts.map +1 -0
- package/dist/cookies/client.js +3 -0
- package/dist/cookies/client.js.map +1 -0
- package/dist/cookies/generated.d.ts +2669 -0
- package/dist/cookies/generated.d.ts.map +1 -0
- package/dist/cookies/generated.js +6 -0
- package/dist/cookies/generated.js.map +1 -0
- package/dist/cookies/index.d.ts +2 -0
- package/dist/cookies/index.d.ts.map +1 -0
- package/dist/cookies/index.js +2 -0
- package/dist/cookies/index.js.map +1 -0
- package/dist/courses/client.d.ts +3 -0
- package/dist/courses/client.d.ts.map +1 -0
- package/dist/courses/client.js +3 -0
- package/dist/courses/client.js.map +1 -0
- package/dist/courses/generated.d.ts +4939 -0
- package/dist/courses/generated.d.ts.map +1 -0
- package/dist/courses/generated.js +6 -0
- package/dist/courses/generated.js.map +1 -0
- package/dist/courses/index.d.ts +2 -0
- package/dist/courses/index.d.ts.map +1 -0
- package/dist/courses/index.js +2 -0
- package/dist/courses/index.js.map +1 -0
- package/dist/custom/client.d.ts +3 -0
- package/dist/custom/client.d.ts.map +1 -0
- package/dist/custom/client.js +3 -0
- package/dist/custom/client.js.map +1 -0
- package/dist/custom/generated.d.ts +4377 -0
- package/dist/custom/generated.d.ts.map +1 -0
- package/dist/custom/generated.js +6 -0
- package/dist/custom/generated.js.map +1 -0
- package/dist/custom/index.d.ts +2 -0
- package/dist/custom/index.d.ts.map +1 -0
- package/dist/custom/index.js +2 -0
- package/dist/custom/index.js.map +1 -0
- package/dist/dashboard/generated.d.ts +202 -202
- package/dist/dashboard/generated.d.ts.map +1 -1
- package/dist/elasticsearch/client.d.ts +3 -0
- package/dist/elasticsearch/client.d.ts.map +1 -0
- package/dist/elasticsearch/client.js +3 -0
- package/dist/elasticsearch/client.js.map +1 -0
- package/dist/elasticsearch/generated.d.ts +5650 -0
- package/dist/elasticsearch/generated.d.ts.map +1 -0
- package/dist/elasticsearch/generated.js +6 -0
- package/dist/elasticsearch/generated.js.map +1 -0
- package/dist/elasticsearch/index.d.ts +2 -0
- package/dist/elasticsearch/index.d.ts.map +1 -0
- package/dist/elasticsearch/index.js +2 -0
- package/dist/elasticsearch/index.js.map +1 -0
- package/dist/enrollments/client.d.ts +3 -0
- package/dist/enrollments/client.d.ts.map +1 -0
- package/dist/enrollments/client.js +3 -0
- package/dist/enrollments/client.js.map +1 -0
- package/dist/enrollments/generated.d.ts +1284 -0
- package/dist/enrollments/generated.d.ts.map +1 -0
- package/dist/enrollments/generated.js +6 -0
- package/dist/enrollments/generated.js.map +1 -0
- package/dist/enrollments/index.d.ts +2 -0
- package/dist/enrollments/index.d.ts.map +1 -0
- package/dist/enrollments/index.js +2 -0
- package/dist/enrollments/index.js.map +1 -0
- package/dist/errors/generated.d.ts +15 -15
- package/dist/errors/generated.d.ts.map +1 -1
- package/dist/eventconfig/client.d.ts +3 -0
- package/dist/eventconfig/client.d.ts.map +1 -0
- package/dist/eventconfig/client.js +3 -0
- package/dist/eventconfig/client.js.map +1 -0
- package/dist/eventconfig/generated.d.ts +2782 -0
- package/dist/eventconfig/generated.d.ts.map +1 -0
- package/dist/eventconfig/generated.js +6 -0
- package/dist/eventconfig/generated.js.map +1 -0
- package/dist/eventconfig/index.d.ts +2 -0
- package/dist/eventconfig/index.d.ts.map +1 -0
- package/dist/eventconfig/index.js +2 -0
- package/dist/eventconfig/index.js.map +1 -0
- package/dist/funnels/client.d.ts +3 -0
- package/dist/funnels/client.d.ts.map +1 -0
- package/dist/funnels/client.js +3 -0
- package/dist/funnels/client.js.map +1 -0
- package/dist/funnels/generated.d.ts +5231 -0
- package/dist/funnels/generated.d.ts.map +1 -0
- package/dist/funnels/generated.js +6 -0
- package/dist/funnels/generated.js.map +1 -0
- package/dist/funnels/index.d.ts +2 -0
- package/dist/funnels/index.d.ts.map +1 -0
- package/dist/funnels/index.js +2 -0
- package/dist/funnels/index.js.map +1 -0
- package/dist/gamification/client.d.ts +3 -0
- package/dist/gamification/client.d.ts.map +1 -0
- package/dist/gamification/client.js +3 -0
- package/dist/gamification/client.js.map +1 -0
- package/dist/gamification/generated.d.ts +4396 -0
- package/dist/gamification/generated.d.ts.map +1 -0
- package/dist/gamification/generated.js +6 -0
- package/dist/gamification/generated.js.map +1 -0
- package/dist/gamification/index.d.ts +2 -0
- package/dist/gamification/index.d.ts.map +1 -0
- package/dist/gamification/index.js +2 -0
- package/dist/gamification/index.js.map +1 -0
- package/dist/impersonation/client.d.ts +3 -0
- package/dist/impersonation/client.d.ts.map +1 -0
- package/dist/impersonation/client.js +3 -0
- package/dist/impersonation/client.js.map +1 -0
- package/dist/impersonation/generated.d.ts +469 -0
- package/dist/impersonation/generated.d.ts.map +1 -0
- package/dist/impersonation/generated.js +6 -0
- package/dist/impersonation/generated.js.map +1 -0
- package/dist/impersonation/index.d.ts +2 -0
- package/dist/impersonation/index.d.ts.map +1 -0
- package/dist/impersonation/index.js +2 -0
- package/dist/impersonation/index.js.map +1 -0
- package/dist/inbox/client.d.ts +3 -0
- package/dist/inbox/client.d.ts.map +1 -0
- package/dist/inbox/client.js +3 -0
- package/dist/inbox/client.js.map +1 -0
- package/dist/inbox/generated.d.ts +7813 -0
- package/dist/inbox/generated.d.ts.map +1 -0
- package/dist/inbox/generated.js +6 -0
- package/dist/inbox/generated.js.map +1 -0
- package/dist/inbox/index.d.ts +2 -0
- package/dist/inbox/index.d.ts.map +1 -0
- package/dist/inbox/index.js +2 -0
- package/dist/inbox/index.js.map +1 -0
- package/dist/index.d.ts +54 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +54 -0
- package/dist/index.js.map +1 -1
- package/dist/internal/client.d.ts +3 -0
- package/dist/internal/client.d.ts.map +1 -0
- package/dist/internal/client.js +3 -0
- package/dist/internal/client.js.map +1 -0
- package/dist/internal/generated.d.ts +626 -0
- package/dist/internal/generated.d.ts.map +1 -0
- package/dist/internal/generated.js +6 -0
- package/dist/internal/generated.js.map +1 -0
- package/dist/internal/index.d.ts +2 -0
- package/dist/internal/index.d.ts.map +1 -0
- package/dist/internal/index.js +2 -0
- package/dist/internal/index.js.map +1 -0
- package/dist/internationalization/generated.d.ts +15 -15
- package/dist/internationalization/generated.d.ts.map +1 -1
- package/dist/invitations/generated.d.ts +143 -143
- package/dist/invitations/generated.d.ts.map +1 -1
- package/dist/meetings/client.d.ts +3 -0
- package/dist/meetings/client.d.ts.map +1 -0
- package/dist/meetings/client.js +3 -0
- package/dist/meetings/client.js.map +1 -0
- package/dist/meetings/generated.d.ts +1800 -0
- package/dist/meetings/generated.d.ts.map +1 -0
- package/dist/meetings/generated.js +6 -0
- package/dist/meetings/generated.js.map +1 -0
- package/dist/meetings/index.d.ts +2 -0
- package/dist/meetings/index.d.ts.map +1 -0
- package/dist/meetings/index.js +2 -0
- package/dist/meetings/index.js.map +1 -0
- package/dist/metas/client.d.ts +3 -0
- package/dist/metas/client.d.ts.map +1 -0
- package/dist/metas/client.js +3 -0
- package/dist/metas/client.js.map +1 -0
- package/dist/metas/generated.d.ts +8459 -0
- package/dist/metas/generated.d.ts.map +1 -0
- package/dist/metas/generated.js +6 -0
- package/dist/metas/generated.js.map +1 -0
- package/dist/metas/index.d.ts +2 -0
- package/dist/metas/index.d.ts.map +1 -0
- package/dist/metas/index.js +2 -0
- package/dist/metas/index.js.map +1 -0
- package/dist/notification/client.d.ts +3 -0
- package/dist/notification/client.d.ts.map +1 -0
- package/dist/notification/client.js +3 -0
- package/dist/notification/client.js.map +1 -0
- package/dist/notification/generated.d.ts +23762 -0
- package/dist/notification/generated.d.ts.map +1 -0
- package/dist/notification/generated.js +6 -0
- package/dist/notification/generated.js.map +1 -0
- package/dist/notification/index.d.ts +2 -0
- package/dist/notification/index.d.ts.map +1 -0
- package/dist/notification/index.js +2 -0
- package/dist/notification/index.js.map +1 -0
- package/dist/notifications/client.d.ts +3 -0
- package/dist/notifications/client.d.ts.map +1 -0
- package/dist/notifications/client.js +3 -0
- package/dist/notifications/client.js.map +1 -0
- package/dist/notifications/generated.d.ts +2020 -0
- package/dist/notifications/generated.d.ts.map +1 -0
- package/dist/notifications/generated.js +6 -0
- package/dist/notifications/generated.js.map +1 -0
- package/dist/notifications/index.d.ts +2 -0
- package/dist/notifications/index.d.ts.map +1 -0
- package/dist/notifications/index.js +2 -0
- package/dist/notifications/index.js.map +1 -0
- package/dist/onboarding/client.d.ts +3 -0
- package/dist/onboarding/client.d.ts.map +1 -0
- package/dist/onboarding/client.js +3 -0
- package/dist/onboarding/client.js.map +1 -0
- package/dist/onboarding/generated.d.ts +3404 -0
- package/dist/onboarding/generated.d.ts.map +1 -0
- package/dist/onboarding/generated.js +6 -0
- package/dist/onboarding/generated.js.map +1 -0
- package/dist/onboarding/index.d.ts +2 -0
- package/dist/onboarding/index.d.ts.map +1 -0
- package/dist/onboarding/index.js +2 -0
- package/dist/onboarding/index.js.map +1 -0
- package/dist/packages/client.d.ts +3 -0
- package/dist/packages/client.d.ts.map +1 -0
- package/dist/packages/client.js +3 -0
- package/dist/packages/client.js.map +1 -0
- package/dist/packages/generated.d.ts +2812 -0
- package/dist/packages/generated.d.ts.map +1 -0
- package/dist/packages/generated.js +6 -0
- package/dist/packages/generated.js.map +1 -0
- package/dist/packages/index.d.ts +2 -0
- package/dist/packages/index.d.ts.map +1 -0
- package/dist/packages/index.js +2 -0
- package/dist/packages/index.js.map +1 -0
- package/dist/payments/client.d.ts +3 -0
- package/dist/payments/client.d.ts.map +1 -0
- package/dist/payments/client.js +3 -0
- package/dist/payments/client.js.map +1 -0
- package/dist/payments/generated.d.ts +21207 -0
- package/dist/payments/generated.d.ts.map +1 -0
- package/dist/payments/generated.js +6 -0
- package/dist/payments/generated.js.map +1 -0
- package/dist/payments/index.d.ts +2 -0
- package/dist/payments/index.d.ts.map +1 -0
- package/dist/payments/index.js +2 -0
- package/dist/payments/index.js.map +1 -0
- package/dist/payouts/client.d.ts +3 -0
- package/dist/payouts/client.d.ts.map +1 -0
- package/dist/payouts/client.js +3 -0
- package/dist/payouts/client.js.map +1 -0
- package/dist/payouts/generated.d.ts +15067 -0
- package/dist/payouts/generated.d.ts.map +1 -0
- package/dist/payouts/generated.js +6 -0
- package/dist/payouts/generated.js.map +1 -0
- package/dist/payouts/index.d.ts +2 -0
- package/dist/payouts/index.d.ts.map +1 -0
- package/dist/payouts/index.js +2 -0
- package/dist/payouts/index.js.map +1 -0
- package/dist/plans/client.d.ts +3 -0
- package/dist/plans/client.d.ts.map +1 -0
- package/dist/plans/client.js +3 -0
- package/dist/plans/client.js.map +1 -0
- package/dist/plans/generated.d.ts +1944 -0
- package/dist/plans/generated.d.ts.map +1 -0
- package/dist/plans/generated.js +6 -0
- package/dist/plans/generated.js.map +1 -0
- package/dist/plans/index.d.ts +2 -0
- package/dist/plans/index.d.ts.map +1 -0
- package/dist/plans/index.js +2 -0
- package/dist/plans/index.js.map +1 -0
- package/dist/pricing/client.d.ts +3 -0
- package/dist/pricing/client.d.ts.map +1 -0
- package/dist/pricing/client.js +3 -0
- package/dist/pricing/client.js.map +1 -0
- package/dist/pricing/generated.d.ts +2364 -0
- package/dist/pricing/generated.d.ts.map +1 -0
- package/dist/pricing/generated.js +6 -0
- package/dist/pricing/generated.js.map +1 -0
- package/dist/pricing/index.d.ts +2 -0
- package/dist/pricing/index.d.ts.map +1 -0
- package/dist/pricing/index.js +2 -0
- package/dist/pricing/index.js.map +1 -0
- package/dist/products/client.d.ts +3 -0
- package/dist/products/client.d.ts.map +1 -0
- package/dist/products/client.js +3 -0
- package/dist/products/client.js.map +1 -0
- package/dist/products/generated.d.ts +9678 -0
- package/dist/products/generated.d.ts.map +1 -0
- package/dist/products/generated.js +6 -0
- package/dist/products/generated.js.map +1 -0
- package/dist/products/index.d.ts +2 -0
- package/dist/products/index.d.ts.map +1 -0
- package/dist/products/index.js +2 -0
- package/dist/products/index.js.map +1 -0
- package/dist/profile/client.d.ts +3 -0
- package/dist/profile/client.d.ts.map +1 -0
- package/dist/profile/client.js +3 -0
- package/dist/profile/client.js.map +1 -0
- package/dist/profile/generated.d.ts +7005 -0
- package/dist/profile/generated.d.ts.map +1 -0
- package/dist/profile/generated.js +6 -0
- package/dist/profile/generated.js.map +1 -0
- package/dist/profile/index.d.ts +2 -0
- package/dist/profile/index.d.ts.map +1 -0
- package/dist/profile/index.js +2 -0
- package/dist/profile/index.js.map +1 -0
- package/dist/reasons/client.d.ts +3 -0
- package/dist/reasons/client.d.ts.map +1 -0
- package/dist/reasons/client.js +3 -0
- package/dist/reasons/client.js.map +1 -0
- package/dist/reasons/generated.d.ts +1913 -0
- package/dist/reasons/generated.d.ts.map +1 -0
- package/dist/reasons/generated.js +6 -0
- package/dist/reasons/generated.js.map +1 -0
- package/dist/reasons/index.d.ts +2 -0
- package/dist/reasons/index.d.ts.map +1 -0
- package/dist/reasons/index.js +2 -0
- package/dist/reasons/index.js.map +1 -0
- package/dist/registration/generated.d.ts +163 -163
- package/dist/registration/generated.d.ts.map +1 -1
- package/dist/reviews/client.d.ts +3 -0
- package/dist/reviews/client.d.ts.map +1 -0
- package/dist/reviews/client.js +3 -0
- package/dist/reviews/client.js.map +1 -0
- package/dist/reviews/generated.d.ts +3020 -0
- package/dist/reviews/generated.d.ts.map +1 -0
- package/dist/reviews/generated.js +6 -0
- package/dist/reviews/generated.js.map +1 -0
- package/dist/reviews/index.d.ts +2 -0
- package/dist/reviews/index.d.ts.map +1 -0
- package/dist/reviews/index.js +2 -0
- package/dist/reviews/index.js.map +1 -0
- package/dist/role/generated.d.ts +203 -203
- package/dist/role/generated.d.ts.map +1 -1
- package/dist/scheduling/client.d.ts +3 -0
- package/dist/scheduling/client.d.ts.map +1 -0
- package/dist/scheduling/client.js +3 -0
- package/dist/scheduling/client.js.map +1 -0
- package/dist/scheduling/generated.d.ts +2016 -0
- package/dist/scheduling/generated.d.ts.map +1 -0
- package/dist/scheduling/generated.js +6 -0
- package/dist/scheduling/generated.js.map +1 -0
- package/dist/scheduling/index.d.ts +2 -0
- package/dist/scheduling/index.d.ts.map +1 -0
- package/dist/scheduling/index.js +2 -0
- package/dist/scheduling/index.js.map +1 -0
- package/dist/services/client.d.ts +3 -0
- package/dist/services/client.d.ts.map +1 -0
- package/dist/services/client.js +3 -0
- package/dist/services/client.js.map +1 -0
- package/dist/services/generated.d.ts +19185 -0
- package/dist/services/generated.d.ts.map +1 -0
- package/dist/services/generated.js +6 -0
- package/dist/services/generated.js.map +1 -0
- package/dist/services/index.d.ts +2 -0
- package/dist/services/index.d.ts.map +1 -0
- package/dist/services/index.js +2 -0
- package/dist/services/index.js.map +1 -0
- package/dist/sessions/client.d.ts +3 -0
- package/dist/sessions/client.d.ts.map +1 -0
- package/dist/sessions/client.js +3 -0
- package/dist/sessions/client.js.map +1 -0
- package/dist/sessions/generated.d.ts +2059 -0
- package/dist/sessions/generated.d.ts.map +1 -0
- package/dist/sessions/generated.js +6 -0
- package/dist/sessions/generated.js.map +1 -0
- package/dist/sessions/index.d.ts +2 -0
- package/dist/sessions/index.d.ts.map +1 -0
- package/dist/sessions/index.js +2 -0
- package/dist/sessions/index.js.map +1 -0
- package/dist/spaces/client.d.ts +3 -0
- package/dist/spaces/client.d.ts.map +1 -0
- package/dist/spaces/client.js +3 -0
- package/dist/spaces/client.js.map +1 -0
- package/dist/spaces/generated.d.ts +8813 -0
- package/dist/spaces/generated.d.ts.map +1 -0
- package/dist/spaces/generated.js +6 -0
- package/dist/spaces/generated.js.map +1 -0
- package/dist/spaces/index.d.ts +2 -0
- package/dist/spaces/index.d.ts.map +1 -0
- package/dist/spaces/index.js +2 -0
- package/dist/spaces/index.js.map +1 -0
- package/dist/storefront/client.d.ts +3 -0
- package/dist/storefront/client.d.ts.map +1 -0
- package/dist/storefront/client.js +3 -0
- package/dist/storefront/client.js.map +1 -0
- package/dist/storefront/generated.d.ts +1851 -0
- package/dist/storefront/generated.d.ts.map +1 -0
- package/dist/storefront/generated.js +6 -0
- package/dist/storefront/generated.js.map +1 -0
- package/dist/storefront/index.d.ts +2 -0
- package/dist/storefront/index.d.ts.map +1 -0
- package/dist/storefront/index.js +2 -0
- package/dist/storefront/index.js.map +1 -0
- package/dist/support/client.d.ts +3 -0
- package/dist/support/client.d.ts.map +1 -0
- package/dist/support/client.js +3 -0
- package/dist/support/client.js.map +1 -0
- package/dist/support/generated.d.ts +25017 -0
- package/dist/support/generated.d.ts.map +1 -0
- package/dist/support/generated.js +6 -0
- package/dist/support/generated.js.map +1 -0
- package/dist/support/index.d.ts +2 -0
- package/dist/support/index.d.ts.map +1 -0
- package/dist/support/index.js +2 -0
- package/dist/support/index.js.map +1 -0
- package/dist/sync/client.d.ts +3 -0
- package/dist/sync/client.d.ts.map +1 -0
- package/dist/sync/client.js +3 -0
- package/dist/sync/client.js.map +1 -0
- package/dist/sync/generated.d.ts +4919 -0
- package/dist/sync/generated.d.ts.map +1 -0
- package/dist/sync/generated.js +6 -0
- package/dist/sync/generated.js.map +1 -0
- package/dist/sync/index.d.ts +2 -0
- package/dist/sync/index.d.ts.map +1 -0
- package/dist/sync/index.js +2 -0
- package/dist/sync/index.js.map +1 -0
- package/dist/tenant/generated.d.ts +540 -540
- package/dist/tenant/generated.d.ts.map +1 -1
- package/dist/testimonials/client.d.ts +3 -0
- package/dist/testimonials/client.d.ts.map +1 -0
- package/dist/testimonials/client.js +3 -0
- package/dist/testimonials/client.js.map +1 -0
- package/dist/testimonials/generated.d.ts +2731 -0
- package/dist/testimonials/generated.d.ts.map +1 -0
- package/dist/testimonials/generated.js +6 -0
- package/dist/testimonials/generated.js.map +1 -0
- package/dist/testimonials/index.d.ts +2 -0
- package/dist/testimonials/index.d.ts.map +1 -0
- package/dist/testimonials/index.js +2 -0
- package/dist/testimonials/index.js.map +1 -0
- package/dist/tests/client.d.ts +3 -0
- package/dist/tests/client.d.ts.map +1 -0
- package/dist/tests/client.js +3 -0
- package/dist/tests/client.js.map +1 -0
- package/dist/tests/generated.d.ts +6071 -0
- package/dist/tests/generated.d.ts.map +1 -0
- package/dist/tests/generated.js +6 -0
- package/dist/tests/generated.js.map +1 -0
- package/dist/tests/index.d.ts +2 -0
- package/dist/tests/index.d.ts.map +1 -0
- package/dist/tests/index.js +2 -0
- package/dist/tests/index.js.map +1 -0
- package/dist/tokens/generated.d.ts +49 -49
- package/dist/tokens/generated.d.ts.map +1 -1
- package/dist/uploads/client.d.ts +3 -0
- package/dist/uploads/client.d.ts.map +1 -0
- package/dist/uploads/client.js +3 -0
- package/dist/uploads/client.js.map +1 -0
- package/dist/uploads/generated.d.ts +1831 -0
- package/dist/uploads/generated.d.ts.map +1 -0
- package/dist/uploads/generated.js +6 -0
- package/dist/uploads/generated.js.map +1 -0
- package/dist/uploads/index.d.ts +2 -0
- package/dist/uploads/index.d.ts.map +1 -0
- package/dist/uploads/index.js +2 -0
- package/dist/uploads/index.js.map +1 -0
- package/dist/upsell/client.d.ts +3 -0
- package/dist/upsell/client.d.ts.map +1 -0
- package/dist/upsell/client.js +3 -0
- package/dist/upsell/client.js.map +1 -0
- package/dist/upsell/generated.d.ts +2459 -0
- package/dist/upsell/generated.d.ts.map +1 -0
- package/dist/upsell/generated.js +6 -0
- package/dist/upsell/generated.js.map +1 -0
- package/dist/upsell/index.d.ts +2 -0
- package/dist/upsell/index.d.ts.map +1 -0
- package/dist/upsell/index.js +2 -0
- package/dist/upsell/index.js.map +1 -0
- package/dist/user/generated.d.ts +108 -108
- package/dist/user/generated.d.ts.map +1 -1
- package/dist/webinars/client.d.ts +3 -0
- package/dist/webinars/client.d.ts.map +1 -0
- package/dist/webinars/client.js +3 -0
- package/dist/webinars/client.js.map +1 -0
- package/dist/webinars/generated.d.ts +1846 -0
- package/dist/webinars/generated.d.ts.map +1 -0
- package/dist/webinars/generated.js +6 -0
- package/dist/webinars/generated.js.map +1 -0
- package/dist/webinars/index.d.ts +2 -0
- package/dist/webinars/index.d.ts.map +1 -0
- package/dist/webinars/index.js +2 -0
- package/dist/webinars/index.js.map +1 -0
- package/package.json +63 -5
|
@@ -0,0 +1,2922 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
export interface paths {
|
|
6
|
+
"/v1/announcements": {
|
|
7
|
+
parameters: {
|
|
8
|
+
query?: never;
|
|
9
|
+
header?: never;
|
|
10
|
+
path?: never;
|
|
11
|
+
cookie?: never;
|
|
12
|
+
};
|
|
13
|
+
/**
|
|
14
|
+
* List Announcements
|
|
15
|
+
* @description Get active announcements for current user based on targeting and schedule.
|
|
16
|
+
*
|
|
17
|
+
* **For**: All users (logged-in and guests)
|
|
18
|
+
* **Purpose**: Fetch announcements to display on current page/context
|
|
19
|
+
*
|
|
20
|
+
* **Query Parameters**:
|
|
21
|
+
* - context_type (optional): Context type (course, product, bundle, lesson, session, package)
|
|
22
|
+
* - context_id (optional): Context entity ID (e.g., course ID 123)
|
|
23
|
+
* - display_type (optional): Filter by display type (bar_top, bar_bottom, modal, card, badge, inline)
|
|
24
|
+
* - page_route (optional): Current page route for page-specific announcements
|
|
25
|
+
*
|
|
26
|
+
* **Example Requests**:
|
|
27
|
+
* ```
|
|
28
|
+
* GET /v1/announcements/active
|
|
29
|
+
* GET /v1/announcements/active?context_type=course&context_id=123
|
|
30
|
+
* GET /v1/announcements/active?display_type=bar_top
|
|
31
|
+
* GET /v1/announcements/active?context_type=product&context_id=45&display_type=modal
|
|
32
|
+
* ```
|
|
33
|
+
*
|
|
34
|
+
* **Flow**:
|
|
35
|
+
* 1. Fetch active announcements for org_id
|
|
36
|
+
* 2. Filter by schedule (starts_at, ends_at, time windows)
|
|
37
|
+
* 3. Filter by context scoping (global vs specific course/product)
|
|
38
|
+
* 4. Filter by audience targeting (all, logged_in, guests, enrolled_only, not_enrolled)
|
|
39
|
+
* 5. Check user interaction history (dismissed, max impressions)
|
|
40
|
+
* 6. Sort by priority (highest first)
|
|
41
|
+
* 7. Return formatted announcements
|
|
42
|
+
*
|
|
43
|
+
* **Authentication**: Optional (works for both authenticated users and guests)
|
|
44
|
+
* **Headers**:
|
|
45
|
+
* - Authorization: Bearer <token> (optional for logged-in users)
|
|
46
|
+
* - X-Guest-Session-ID: <uuid> (optional for guests)
|
|
47
|
+
*
|
|
48
|
+
* **Response**: List of active announcements with display data
|
|
49
|
+
*
|
|
50
|
+
* **Use Cases**:
|
|
51
|
+
* - Show global site-wide announcements
|
|
52
|
+
* - Show course-specific announcements to enrolled students
|
|
53
|
+
* - Show upsell banners to non-enrolled visitors on course pages
|
|
54
|
+
* - Show promotional modals on homepage
|
|
55
|
+
*/
|
|
56
|
+
get: operations["listAnnouncements"];
|
|
57
|
+
put?: never;
|
|
58
|
+
post?: never;
|
|
59
|
+
delete?: never;
|
|
60
|
+
options?: never;
|
|
61
|
+
head?: never;
|
|
62
|
+
patch?: never;
|
|
63
|
+
trace?: never;
|
|
64
|
+
};
|
|
65
|
+
"/v1/announcements/{announcement_id}/interactions": {
|
|
66
|
+
parameters: {
|
|
67
|
+
query?: never;
|
|
68
|
+
header?: never;
|
|
69
|
+
path?: never;
|
|
70
|
+
cookie?: never;
|
|
71
|
+
};
|
|
72
|
+
get?: never;
|
|
73
|
+
put?: never;
|
|
74
|
+
/**
|
|
75
|
+
* Track Announcement Interaction
|
|
76
|
+
* @description Track user interaction with announcement.
|
|
77
|
+
*
|
|
78
|
+
* **For**: All users (logged-in and guests)
|
|
79
|
+
* **Purpose**: Record user engagement (views, clicks, dismissals) for analytics
|
|
80
|
+
*
|
|
81
|
+
* **Path Parameters**:
|
|
82
|
+
* - announcement_id: External announcement ID (ann_xxx)
|
|
83
|
+
*
|
|
84
|
+
* **Example Request Body**:
|
|
85
|
+
* ```json
|
|
86
|
+
* {
|
|
87
|
+
* "action": "viewed"
|
|
88
|
+
* }
|
|
89
|
+
* ```
|
|
90
|
+
*
|
|
91
|
+
* **Valid Actions**:
|
|
92
|
+
* - `viewed`: User saw the announcement (impression)
|
|
93
|
+
* - `clicked`: User clicked the CTA button
|
|
94
|
+
* - `dismissed`: User closed/dismissed the announcement
|
|
95
|
+
* - `acknowledged`: User acknowledged the announcement (for modals requiring acknowledgment)
|
|
96
|
+
*
|
|
97
|
+
* **Flow**:
|
|
98
|
+
* 1. Validate announcement exists
|
|
99
|
+
* 2. Extract tracking context (IP, user agent)
|
|
100
|
+
* 3. Record interaction based on action type
|
|
101
|
+
* 4. Update analytics metrics (impressions, clicks, dismissals)
|
|
102
|
+
* 5. Return confirmation
|
|
103
|
+
*
|
|
104
|
+
* **Authentication**: Optional (works for both authenticated users and guests)
|
|
105
|
+
* **Headers**:
|
|
106
|
+
* - Authorization: Bearer <token> (optional for logged-in users)
|
|
107
|
+
* - X-Guest-Session-ID: <uuid> (optional for guests)
|
|
108
|
+
*
|
|
109
|
+
* **Response**: Confirmation message
|
|
110
|
+
*
|
|
111
|
+
* **Use Cases**:
|
|
112
|
+
* - Track how many times announcement was viewed
|
|
113
|
+
* - Track CTA click-through rate
|
|
114
|
+
* - Prevent showing dismissed announcements again
|
|
115
|
+
* - Calculate engagement metrics for admin dashboard
|
|
116
|
+
*
|
|
117
|
+
* **Note**: Frontend should call this automatically when:
|
|
118
|
+
* - Announcement is displayed → action: "viewed"
|
|
119
|
+
* - User clicks CTA button → action: "clicked"
|
|
120
|
+
* - User dismisses announcement → action: "dismissed"
|
|
121
|
+
* - User acknowledges modal → action: "acknowledged"
|
|
122
|
+
*/
|
|
123
|
+
post: operations["createAnnouncementInteraction"];
|
|
124
|
+
delete?: never;
|
|
125
|
+
options?: never;
|
|
126
|
+
head?: never;
|
|
127
|
+
patch?: never;
|
|
128
|
+
trace?: never;
|
|
129
|
+
};
|
|
130
|
+
"/v1/announcements/admin": {
|
|
131
|
+
parameters: {
|
|
132
|
+
query?: never;
|
|
133
|
+
header?: never;
|
|
134
|
+
path?: never;
|
|
135
|
+
cookie?: never;
|
|
136
|
+
};
|
|
137
|
+
/**
|
|
138
|
+
* List Announcements
|
|
139
|
+
* @description List all announcements with pagination and filters.
|
|
140
|
+
*
|
|
141
|
+
* **For**: Admin users with announcement_manage permission
|
|
142
|
+
* **Purpose**: View and manage all announcements
|
|
143
|
+
*
|
|
144
|
+
* **Query Parameters**:
|
|
145
|
+
* - status (optional): Filter by status (draft, active, paused, ended, archived)
|
|
146
|
+
* - context_type (optional): Filter by context type
|
|
147
|
+
* - display_type (optional): Filter by display type
|
|
148
|
+
* - page (default: 1): Page number
|
|
149
|
+
* - limit (default: 20, max: 100): Items per page
|
|
150
|
+
*
|
|
151
|
+
* **Example Requests**:
|
|
152
|
+
* ```
|
|
153
|
+
* GET /v1/announcements/admin
|
|
154
|
+
* GET /v1/announcements/admin?status=active
|
|
155
|
+
* GET /v1/announcements/admin?display_type=bar_top&page=2&limit=50
|
|
156
|
+
* ```
|
|
157
|
+
*
|
|
158
|
+
* **Flow**:
|
|
159
|
+
* 1. Parse filters and pagination
|
|
160
|
+
* 2. Fetch announcements from database
|
|
161
|
+
* 3. Count total for pagination
|
|
162
|
+
* 4. Return paginated list
|
|
163
|
+
*
|
|
164
|
+
* **Authentication**: Required (admin users only)
|
|
165
|
+
* **Headers**: Authorization: Bearer <token>
|
|
166
|
+
*
|
|
167
|
+
* **Response**: Paginated list of announcements with metadata
|
|
168
|
+
* ```json
|
|
169
|
+
* {
|
|
170
|
+
* "announcements": [...],
|
|
171
|
+
* "pagination": {
|
|
172
|
+
* "page": 1,
|
|
173
|
+
* "limit": 20,
|
|
174
|
+
* "total": 150,
|
|
175
|
+
* "total_pages": 8
|
|
176
|
+
* }
|
|
177
|
+
* }
|
|
178
|
+
* ```
|
|
179
|
+
*/
|
|
180
|
+
get: operations["listAnnouncementsAdmin"];
|
|
181
|
+
put?: never;
|
|
182
|
+
/**
|
|
183
|
+
* Create Announcement
|
|
184
|
+
* @description Create a new announcement.
|
|
185
|
+
*
|
|
186
|
+
* **For**: Admin users with announcement_manage permission
|
|
187
|
+
* **Purpose**: Create draft or active announcements for users
|
|
188
|
+
*
|
|
189
|
+
* **Required Fields**:
|
|
190
|
+
* - title: Announcement title/headline (max 255 chars)
|
|
191
|
+
* - message: Main announcement content (supports markdown)
|
|
192
|
+
* - display_type: bar_top, bar_bottom, modal, card, badge, inline
|
|
193
|
+
*
|
|
194
|
+
* **Optional Fields**:
|
|
195
|
+
* - context_type: global (default), course, product, bundle, lesson, session, package
|
|
196
|
+
* - context_id: Required if context_type is not 'global'
|
|
197
|
+
* - target_audience: all (default), logged_in, guests, enrolled_only, not_enrolled, segments, specific_users
|
|
198
|
+
* - status: draft (default) or active
|
|
199
|
+
* - starts_at: Schedule start (ISO 8601 datetime)
|
|
200
|
+
* - ends_at: Schedule end (ISO 8601 datetime)
|
|
201
|
+
* - priority: 0-100 (default 50), higher = shown first
|
|
202
|
+
* - is_dismissible: true/false
|
|
203
|
+
* - max_impressions_per_user: Limit views per user
|
|
204
|
+
* - cta_text: Call-to-action button text
|
|
205
|
+
* - cta_url: Call-to-action button URL
|
|
206
|
+
* - cta_style: primary, secondary, link
|
|
207
|
+
* - time_window_start: Show only after this time (HH:MM:SS)
|
|
208
|
+
* - time_window_end: Show only before this time (HH:MM:SS)
|
|
209
|
+
* - days_of_week: Array of day numbers (0=Sunday, 6=Saturday)
|
|
210
|
+
* - style_config: JSON object for custom styling
|
|
211
|
+
* - metadata: JSON object for additional data
|
|
212
|
+
*
|
|
213
|
+
* **Example Request Body**:
|
|
214
|
+
* ```json
|
|
215
|
+
* {
|
|
216
|
+
* "title": "New Feature Released!",
|
|
217
|
+
* "message": "Check out our new dashboard analytics",
|
|
218
|
+
* "display_type": "bar_top",
|
|
219
|
+
* "context_type": "global",
|
|
220
|
+
* "target_audience": "all",
|
|
221
|
+
* "status": "draft",
|
|
222
|
+
* "is_dismissible": true,
|
|
223
|
+
* "priority": 80,
|
|
224
|
+
* "cta_text": "Learn More",
|
|
225
|
+
* "cta_url": "/features/analytics",
|
|
226
|
+
* "cta_style": "primary"
|
|
227
|
+
* }
|
|
228
|
+
* ```
|
|
229
|
+
*
|
|
230
|
+
* **Validations**:
|
|
231
|
+
* - context_id required if context_type != 'global'
|
|
232
|
+
* - ends_at must be after starts_at
|
|
233
|
+
* - Only 1 active bar_top or bar_bottom allowed at a time
|
|
234
|
+
* - Invalid display_type rejected
|
|
235
|
+
*
|
|
236
|
+
* **Flow**:
|
|
237
|
+
* 1. Validate request data
|
|
238
|
+
* 2. Check for conflicts (multiple top bars)
|
|
239
|
+
* 3. Generate announcement ID (ann_xxx)
|
|
240
|
+
* 4. Create announcement in database
|
|
241
|
+
* 5. Return created announcement
|
|
242
|
+
*
|
|
243
|
+
* **Authentication**: Required (admin users only)
|
|
244
|
+
* **Headers**: Authorization: Bearer <token>
|
|
245
|
+
* **Response**: Created announcement with external ID
|
|
246
|
+
*
|
|
247
|
+
* **Rate Limit**: 100 requests/minute
|
|
248
|
+
*/
|
|
249
|
+
post: operations["createAnnouncement"];
|
|
250
|
+
delete?: never;
|
|
251
|
+
options?: never;
|
|
252
|
+
head?: never;
|
|
253
|
+
patch?: never;
|
|
254
|
+
trace?: never;
|
|
255
|
+
};
|
|
256
|
+
"/v1/announcements/admin/{announcement_id}": {
|
|
257
|
+
parameters: {
|
|
258
|
+
query?: never;
|
|
259
|
+
header?: never;
|
|
260
|
+
path?: never;
|
|
261
|
+
cookie?: never;
|
|
262
|
+
};
|
|
263
|
+
/**
|
|
264
|
+
* Get Announcement Details
|
|
265
|
+
* @description Get detailed information about a specific announcement.
|
|
266
|
+
*
|
|
267
|
+
* **For**: Admin users with announcement_manage permission
|
|
268
|
+
* **Purpose**: View full announcement details
|
|
269
|
+
*
|
|
270
|
+
* **Path Parameters**:
|
|
271
|
+
* - announcement_id: External announcement ID (ann_xxx)
|
|
272
|
+
*
|
|
273
|
+
* **Example Request**:
|
|
274
|
+
* ```
|
|
275
|
+
* GET /v1/announcements/admin/ann_5j8k3n2m9p
|
|
276
|
+
* ```
|
|
277
|
+
*
|
|
278
|
+
* **Flow**:
|
|
279
|
+
* 1. Validate announcement ID
|
|
280
|
+
* 2. Fetch announcement from database
|
|
281
|
+
* 3. Check org_id ownership
|
|
282
|
+
* 4. Return full details
|
|
283
|
+
*
|
|
284
|
+
* **Authentication**: Required (admin users only)
|
|
285
|
+
* **Headers**: Authorization: Bearer <token>
|
|
286
|
+
*
|
|
287
|
+
* **Response**: Full announcement details including:
|
|
288
|
+
* - Basic info (title, message, display_type)
|
|
289
|
+
* - Targeting (context, audience)
|
|
290
|
+
* - Scheduling (starts_at, ends_at, time windows)
|
|
291
|
+
* - CTA configuration
|
|
292
|
+
* - Style config
|
|
293
|
+
* - Metadata
|
|
294
|
+
* - Audit fields (created_at, created_by, etc.)
|
|
295
|
+
*/
|
|
296
|
+
get: operations["getAnnouncement"];
|
|
297
|
+
put?: never;
|
|
298
|
+
post?: never;
|
|
299
|
+
/**
|
|
300
|
+
* Delete Announcement
|
|
301
|
+
* @description Archive (soft delete) an announcement.
|
|
302
|
+
*
|
|
303
|
+
* **For**: Admin users with announcement_manage permission
|
|
304
|
+
* **Purpose**: Remove announcement from active use
|
|
305
|
+
*
|
|
306
|
+
* **Path Parameters**:
|
|
307
|
+
* - announcement_id: External announcement ID (ann_xxx)
|
|
308
|
+
*
|
|
309
|
+
* **Query Parameters**:
|
|
310
|
+
* - deleted_reason (optional): Reason for archiving
|
|
311
|
+
*
|
|
312
|
+
* **Example Request**:
|
|
313
|
+
* ```
|
|
314
|
+
* DELETE /v1/announcements/admin/ann_5j8k3n2m9p?deleted_reason=Campaign ended
|
|
315
|
+
* ```
|
|
316
|
+
*
|
|
317
|
+
* **Flow**:
|
|
318
|
+
* 1. Fetch announcement
|
|
319
|
+
* 2. Check if already archived
|
|
320
|
+
* 3. Set status to 'archived'
|
|
321
|
+
* 4. Record deleted_by, deleted_at, deleted_reason
|
|
322
|
+
* 5. Invalidate cache
|
|
323
|
+
* 6. Return confirmation
|
|
324
|
+
*
|
|
325
|
+
* **Authentication**: Required (admin users only)
|
|
326
|
+
* **Headers**: Authorization: Bearer <token>
|
|
327
|
+
* **Response**: Confirmation message
|
|
328
|
+
*
|
|
329
|
+
* **Note**: This is a soft delete. Data remains in database but won't be shown to users.
|
|
330
|
+
*/
|
|
331
|
+
delete: operations["deleteAnnouncement"];
|
|
332
|
+
options?: never;
|
|
333
|
+
head?: never;
|
|
334
|
+
/**
|
|
335
|
+
* Update Announcement
|
|
336
|
+
* @description Update an existing announcement.
|
|
337
|
+
*
|
|
338
|
+
* **For**: Admin users with announcement_manage permission
|
|
339
|
+
* **Purpose**: Modify announcement configuration
|
|
340
|
+
*
|
|
341
|
+
* **Path Parameters**:
|
|
342
|
+
* - announcement_id: External announcement ID (ann_xxx)
|
|
343
|
+
*
|
|
344
|
+
* **Updatable Fields**:
|
|
345
|
+
* - title, message, display_type
|
|
346
|
+
* - context_type, context_id
|
|
347
|
+
* - target_audience, target_segments, target_user_ids
|
|
348
|
+
* - starts_at, ends_at
|
|
349
|
+
* - time_window_start, time_window_end, days_of_week
|
|
350
|
+
* - priority, is_dismissible, max_impressions_per_user
|
|
351
|
+
* - cta_text, cta_url, cta_style
|
|
352
|
+
* - style_config, metadata
|
|
353
|
+
*
|
|
354
|
+
* **Note**: Cannot update status here (use publish/pause endpoints)
|
|
355
|
+
*
|
|
356
|
+
* **Example Request Body**:
|
|
357
|
+
* ```json
|
|
358
|
+
* {
|
|
359
|
+
* "title": "Updated Title",
|
|
360
|
+
* "priority": 90,
|
|
361
|
+
* "cta_text": "Get Started Now"
|
|
362
|
+
* }
|
|
363
|
+
* ```
|
|
364
|
+
*
|
|
365
|
+
* **Validations**:
|
|
366
|
+
* - Only draft or paused announcements can be fully updated
|
|
367
|
+
* - Active announcements have limited update scope
|
|
368
|
+
* - context_id required if changing context_type to non-global
|
|
369
|
+
*
|
|
370
|
+
* **Flow**:
|
|
371
|
+
* 1. Fetch existing announcement
|
|
372
|
+
* 2. Validate update permissions
|
|
373
|
+
* 3. Check for conflicts if changing display_type
|
|
374
|
+
* 4. Apply updates
|
|
375
|
+
* 5. Return updated announcement
|
|
376
|
+
*
|
|
377
|
+
* **Authentication**: Required (admin users only)
|
|
378
|
+
* **Headers**: Authorization: Bearer <token>
|
|
379
|
+
* **Response**: Updated announcement details
|
|
380
|
+
*/
|
|
381
|
+
patch: operations["updateAnnouncement"];
|
|
382
|
+
trace?: never;
|
|
383
|
+
};
|
|
384
|
+
"/v1/announcements/admin/{announcement_id}/publications": {
|
|
385
|
+
parameters: {
|
|
386
|
+
query?: never;
|
|
387
|
+
header?: never;
|
|
388
|
+
path?: never;
|
|
389
|
+
cookie?: never;
|
|
390
|
+
};
|
|
391
|
+
get?: never;
|
|
392
|
+
put?: never;
|
|
393
|
+
/**
|
|
394
|
+
* Publish Announcement
|
|
395
|
+
* @description Publish an announcement (change status from draft to active).
|
|
396
|
+
*
|
|
397
|
+
* **For**: Admin users with announcement_manage permission
|
|
398
|
+
* **Purpose**: Make announcement visible to users
|
|
399
|
+
*
|
|
400
|
+
* **Path Parameters**:
|
|
401
|
+
* - announcement_id: External announcement ID (ann_xxx)
|
|
402
|
+
*
|
|
403
|
+
* **Example Request**:
|
|
404
|
+
* ```
|
|
405
|
+
* POST /v1/announcements/admin/ann_5j8k3n2m9p/publish
|
|
406
|
+
* ```
|
|
407
|
+
*
|
|
408
|
+
* **Flow**:
|
|
409
|
+
* 1. Fetch announcement
|
|
410
|
+
* 2. Validate status is 'draft'
|
|
411
|
+
* 3. Check for conflicts (e.g., multiple top bars)
|
|
412
|
+
* 4. Set status to 'active'
|
|
413
|
+
* 5. Record published_by, published_at
|
|
414
|
+
* 6. Invalidate cache
|
|
415
|
+
* 7. Return confirmation
|
|
416
|
+
*
|
|
417
|
+
* **Validations**:
|
|
418
|
+
* - Can only publish from 'draft' status
|
|
419
|
+
* - Checks for conflicting active announcements
|
|
420
|
+
* - Validates schedule is not expired
|
|
421
|
+
*
|
|
422
|
+
* **Authentication**: Required (admin users only)
|
|
423
|
+
* **Headers**: Authorization: Bearer <token>
|
|
424
|
+
* **Response**: Published announcement details
|
|
425
|
+
*/
|
|
426
|
+
post: operations["createAnnouncementPublication"];
|
|
427
|
+
delete?: never;
|
|
428
|
+
options?: never;
|
|
429
|
+
head?: never;
|
|
430
|
+
patch?: never;
|
|
431
|
+
trace?: never;
|
|
432
|
+
};
|
|
433
|
+
"/v1/announcements/admin/{announcement_id}/pauses": {
|
|
434
|
+
parameters: {
|
|
435
|
+
query?: never;
|
|
436
|
+
header?: never;
|
|
437
|
+
path?: never;
|
|
438
|
+
cookie?: never;
|
|
439
|
+
};
|
|
440
|
+
get?: never;
|
|
441
|
+
put?: never;
|
|
442
|
+
/**
|
|
443
|
+
* Pause Announcement
|
|
444
|
+
* @description Pause an active announcement (change status from active to paused).
|
|
445
|
+
*
|
|
446
|
+
* **For**: Admin users with announcement_manage permission
|
|
447
|
+
* **Purpose**: Temporarily hide announcement from users
|
|
448
|
+
*
|
|
449
|
+
* **Path Parameters**:
|
|
450
|
+
* - announcement_id: External announcement ID (ann_xxx)
|
|
451
|
+
*
|
|
452
|
+
* **Example Request**:
|
|
453
|
+
* ```
|
|
454
|
+
* POST /v1/announcements/admin/ann_5j8k3n2m9p/pause
|
|
455
|
+
* ```
|
|
456
|
+
*
|
|
457
|
+
* **Flow**:
|
|
458
|
+
* 1. Fetch announcement
|
|
459
|
+
* 2. Validate status is 'active'
|
|
460
|
+
* 3. Set status to 'paused'
|
|
461
|
+
* 4. Invalidate cache
|
|
462
|
+
* 5. Return confirmation
|
|
463
|
+
*
|
|
464
|
+
* **Use Cases**:
|
|
465
|
+
* - Temporarily disable problematic announcement
|
|
466
|
+
* - Pause seasonal campaigns
|
|
467
|
+
* - A/B test by pausing/publishing different variants
|
|
468
|
+
*
|
|
469
|
+
* **Authentication**: Required (admin users only)
|
|
470
|
+
* **Headers**: Authorization: Bearer <token>
|
|
471
|
+
* **Response**: Paused announcement details
|
|
472
|
+
*
|
|
473
|
+
* **Note**: Paused announcements can be published again later
|
|
474
|
+
*/
|
|
475
|
+
post: operations["createAnnouncementPause"];
|
|
476
|
+
delete?: never;
|
|
477
|
+
options?: never;
|
|
478
|
+
head?: never;
|
|
479
|
+
patch?: never;
|
|
480
|
+
trace?: never;
|
|
481
|
+
};
|
|
482
|
+
"/v1/announcements/admin/{announcement_id}/analytics": {
|
|
483
|
+
parameters: {
|
|
484
|
+
query?: never;
|
|
485
|
+
header?: never;
|
|
486
|
+
path?: never;
|
|
487
|
+
cookie?: never;
|
|
488
|
+
};
|
|
489
|
+
/**
|
|
490
|
+
* Get Announcement Analytics
|
|
491
|
+
* @description Get analytics data for a specific announcement.
|
|
492
|
+
*
|
|
493
|
+
* **For**: Admin users with announcement_manage permission
|
|
494
|
+
* **Purpose**: Track announcement performance
|
|
495
|
+
*
|
|
496
|
+
* **Path Parameters**:
|
|
497
|
+
* - announcement_id: External announcement ID (ann_xxx)
|
|
498
|
+
*
|
|
499
|
+
* **Query Parameters**:
|
|
500
|
+
* - start_date (optional): Start date for analytics range (YYYY-MM-DD)
|
|
501
|
+
* - end_date (optional): End date for analytics range (YYYY-MM-DD)
|
|
502
|
+
*
|
|
503
|
+
* **Example Request**:
|
|
504
|
+
* ```
|
|
505
|
+
* GET /v1/announcements/admin/ann_5j8k3n2m9p/analytics
|
|
506
|
+
* GET /v1/announcements/admin/ann_5j8k3n2m9p/analytics?start_date=2025-01-01&end_date=2025-01-31
|
|
507
|
+
* ```
|
|
508
|
+
*
|
|
509
|
+
* **Flow**:
|
|
510
|
+
* 1. Fetch announcement
|
|
511
|
+
* 2. Parse date range (defaults to last 30 days)
|
|
512
|
+
* 3. Fetch analytics from announcement_analytics_tbl
|
|
513
|
+
* 4. Calculate aggregate metrics:
|
|
514
|
+
* - Total impressions (views)
|
|
515
|
+
* - Total clicks
|
|
516
|
+
* - Total dismissals
|
|
517
|
+
* - Click-through rate (CTR)
|
|
518
|
+
* - Dismissal rate
|
|
519
|
+
* 5. Return daily breakdown + summary
|
|
520
|
+
*
|
|
521
|
+
* **Authentication**: Required (admin users only)
|
|
522
|
+
* **Headers**: Authorization: Bearer <token>
|
|
523
|
+
*
|
|
524
|
+
* **Response**:
|
|
525
|
+
* ```json
|
|
526
|
+
* {
|
|
527
|
+
* "announcement_id": "ann_5j8k3n2m9p",
|
|
528
|
+
* "date_range": {
|
|
529
|
+
* "start": "2025-01-01",
|
|
530
|
+
* "end": "2025-01-31"
|
|
531
|
+
* },
|
|
532
|
+
* "summary": {
|
|
533
|
+
* "total_impressions": 15000,
|
|
534
|
+
* "total_clicks": 450,
|
|
535
|
+
* "total_dismissals": 1200,
|
|
536
|
+
* "ctr": 3.0,
|
|
537
|
+
* "dismissal_rate": 8.0
|
|
538
|
+
* },
|
|
539
|
+
* "daily_data": [
|
|
540
|
+
* {
|
|
541
|
+
* "date": "2025-01-01",
|
|
542
|
+
* "impressions": 500,
|
|
543
|
+
* "clicks": 15,
|
|
544
|
+
* "dismissals": 40
|
|
545
|
+
* },
|
|
546
|
+
* ...
|
|
547
|
+
* ]
|
|
548
|
+
* }
|
|
549
|
+
* ```
|
|
550
|
+
*/
|
|
551
|
+
get: operations["getAnnouncementAnalytics"];
|
|
552
|
+
put?: never;
|
|
553
|
+
post?: never;
|
|
554
|
+
delete?: never;
|
|
555
|
+
options?: never;
|
|
556
|
+
head?: never;
|
|
557
|
+
patch?: never;
|
|
558
|
+
trace?: never;
|
|
559
|
+
};
|
|
560
|
+
}
|
|
561
|
+
export type webhooks = Record<string, never>;
|
|
562
|
+
export interface components {
|
|
563
|
+
schemas: {
|
|
564
|
+
/**
|
|
565
|
+
* @example {
|
|
566
|
+
* "status": "success",
|
|
567
|
+
* "message": "Operation successful",
|
|
568
|
+
* "message_code": "api_suc_20001",
|
|
569
|
+
* "data": {},
|
|
570
|
+
* "metadata": {
|
|
571
|
+
* "timestamp": "2026-03-26T10:00:00.000Z",
|
|
572
|
+
* "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
|
|
573
|
+
* "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
|
|
574
|
+
* "version": "v1",
|
|
575
|
+
* "executionTime": 42,
|
|
576
|
+
* "language": "en-US"
|
|
577
|
+
* }
|
|
578
|
+
* }
|
|
579
|
+
*/
|
|
580
|
+
StandardResponse: {
|
|
581
|
+
/** @example success */
|
|
582
|
+
status?: string;
|
|
583
|
+
data?: Record<string, never> | null;
|
|
584
|
+
/** @example Operation successful */
|
|
585
|
+
message?: string | null;
|
|
586
|
+
/** @example api_suc_20001 */
|
|
587
|
+
message_code?: string | null;
|
|
588
|
+
metadata?: Record<string, never> | null;
|
|
589
|
+
error?: components["schemas"]["ErrorResponse"];
|
|
590
|
+
};
|
|
591
|
+
InvalidParam: {
|
|
592
|
+
/** @example items[0].quantity */
|
|
593
|
+
field?: string;
|
|
594
|
+
/** @example Input should be greater than or equal to 1 */
|
|
595
|
+
error?: string;
|
|
596
|
+
};
|
|
597
|
+
/**
|
|
598
|
+
* TrackInteractionRequest
|
|
599
|
+
* @description Request model for tracking user interaction.
|
|
600
|
+
*/
|
|
601
|
+
TrackInteractionRequest: {
|
|
602
|
+
/**
|
|
603
|
+
* Action
|
|
604
|
+
* @description Action type: viewed, clicked, dismissed, acknowledged
|
|
605
|
+
*/
|
|
606
|
+
action: string;
|
|
607
|
+
};
|
|
608
|
+
ErrorResponse: {
|
|
609
|
+
/** @example about:blank */
|
|
610
|
+
type?: string;
|
|
611
|
+
/** @example GENERIC_ERROR */
|
|
612
|
+
code?: string;
|
|
613
|
+
/** @example Client Error */
|
|
614
|
+
title?: string;
|
|
615
|
+
/** @example 400 */
|
|
616
|
+
status?: number;
|
|
617
|
+
/** @example An error occurred */
|
|
618
|
+
detail?: string;
|
|
619
|
+
/** @example /v1/cart/items */
|
|
620
|
+
instance?: string;
|
|
621
|
+
extensions?: components["schemas"]["Extensions"];
|
|
622
|
+
};
|
|
623
|
+
Extensions: {
|
|
624
|
+
/** @example GENERIC_ERROR */
|
|
625
|
+
message_code?: string;
|
|
626
|
+
/** @example [] */
|
|
627
|
+
invalid_params?: components["schemas"]["InvalidParam"][];
|
|
628
|
+
extra_data?: Record<string, never> | null;
|
|
629
|
+
/** @example Detailed debug information */
|
|
630
|
+
debug?: string | null;
|
|
631
|
+
};
|
|
632
|
+
/**
|
|
633
|
+
* AnnouncementCreateRequest
|
|
634
|
+
* @description Request model for creating announcement (admin).
|
|
635
|
+
*/
|
|
636
|
+
AnnouncementCreateRequest: {
|
|
637
|
+
/**
|
|
638
|
+
* Title
|
|
639
|
+
* @description Announcement title
|
|
640
|
+
*/
|
|
641
|
+
title: string;
|
|
642
|
+
/**
|
|
643
|
+
* Message
|
|
644
|
+
* @description Announcement message (supports HTML)
|
|
645
|
+
*/
|
|
646
|
+
message: string;
|
|
647
|
+
/**
|
|
648
|
+
* Display Type
|
|
649
|
+
* @description Display type: bar_top, bar_bottom, modal, card, badge, inline
|
|
650
|
+
* @default bar_top
|
|
651
|
+
*/
|
|
652
|
+
display_type: string;
|
|
653
|
+
/**
|
|
654
|
+
* Theme
|
|
655
|
+
* @description Theme: info, success, warning, error, promotion, custom
|
|
656
|
+
* @default info
|
|
657
|
+
*/
|
|
658
|
+
theme: string;
|
|
659
|
+
/**
|
|
660
|
+
* Background Color
|
|
661
|
+
* @description Custom hex color (e.g., #FF5733)
|
|
662
|
+
*/
|
|
663
|
+
background_color?: string | null;
|
|
664
|
+
/**
|
|
665
|
+
* Text Color
|
|
666
|
+
* @description Custom hex color (e.g., #FFFFFF)
|
|
667
|
+
*/
|
|
668
|
+
text_color?: string | null;
|
|
669
|
+
/**
|
|
670
|
+
* Icon
|
|
671
|
+
* @description Icon name or emoji
|
|
672
|
+
*/
|
|
673
|
+
icon?: string | null;
|
|
674
|
+
/**
|
|
675
|
+
* Cta Text
|
|
676
|
+
* @description Button text
|
|
677
|
+
*/
|
|
678
|
+
cta_text?: string | null;
|
|
679
|
+
/**
|
|
680
|
+
* Cta Url
|
|
681
|
+
* @description Button URL
|
|
682
|
+
*/
|
|
683
|
+
cta_url?: string | null;
|
|
684
|
+
/**
|
|
685
|
+
* Cta Style
|
|
686
|
+
* @description Button style: primary, secondary, link
|
|
687
|
+
* @default primary
|
|
688
|
+
*/
|
|
689
|
+
cta_style: string;
|
|
690
|
+
/**
|
|
691
|
+
* Context Type
|
|
692
|
+
* @description Context: global, course, product, bundle, lesson, session, package
|
|
693
|
+
* @default global
|
|
694
|
+
*/
|
|
695
|
+
context_type: string;
|
|
696
|
+
/**
|
|
697
|
+
* Context Id
|
|
698
|
+
* @description Context entity ID (required if context_type != global)
|
|
699
|
+
*/
|
|
700
|
+
context_id?: number | null;
|
|
701
|
+
/**
|
|
702
|
+
* Target Audience
|
|
703
|
+
* @description Audience: all, logged_in, guests, enrolled_only, not_enrolled, segments, specific_users
|
|
704
|
+
* @default all
|
|
705
|
+
*/
|
|
706
|
+
target_audience: string;
|
|
707
|
+
/**
|
|
708
|
+
* Target User Ids
|
|
709
|
+
* @description User IDs if target_audience=specific_users
|
|
710
|
+
*/
|
|
711
|
+
target_user_ids?: number[] | null;
|
|
712
|
+
/**
|
|
713
|
+
* Target Segments
|
|
714
|
+
* @description Segment criteria
|
|
715
|
+
*/
|
|
716
|
+
target_segments?: {
|
|
717
|
+
[key: string]: unknown;
|
|
718
|
+
} | null;
|
|
719
|
+
/**
|
|
720
|
+
* Target Pages
|
|
721
|
+
* @description Page routes/URLs (null = all pages)
|
|
722
|
+
*/
|
|
723
|
+
target_pages?: string[] | null;
|
|
724
|
+
/**
|
|
725
|
+
* Starts At
|
|
726
|
+
* @description Start datetime (UTC)
|
|
727
|
+
*/
|
|
728
|
+
starts_at?: string | null;
|
|
729
|
+
/**
|
|
730
|
+
* Ends At
|
|
731
|
+
* @description End datetime (UTC)
|
|
732
|
+
*/
|
|
733
|
+
ends_at?: string | null;
|
|
734
|
+
/**
|
|
735
|
+
* Schedule Timezone
|
|
736
|
+
* @description Timezone for schedule
|
|
737
|
+
* @default UTC
|
|
738
|
+
*/
|
|
739
|
+
schedule_timezone: string;
|
|
740
|
+
/**
|
|
741
|
+
* Time Window Start
|
|
742
|
+
* @description Show after this time daily (HH:MM)
|
|
743
|
+
*/
|
|
744
|
+
time_window_start?: string | null;
|
|
745
|
+
/**
|
|
746
|
+
* Time Window End
|
|
747
|
+
* @description Show before this time daily (HH:MM)
|
|
748
|
+
*/
|
|
749
|
+
time_window_end?: string | null;
|
|
750
|
+
/**
|
|
751
|
+
* Is Dismissible
|
|
752
|
+
* @description Can users dismiss?
|
|
753
|
+
* @default true
|
|
754
|
+
*/
|
|
755
|
+
is_dismissible: boolean;
|
|
756
|
+
/**
|
|
757
|
+
* Requires Acknowledgment
|
|
758
|
+
* @description Must click button to dismiss?
|
|
759
|
+
* @default false
|
|
760
|
+
*/
|
|
761
|
+
requires_acknowledgment: boolean;
|
|
762
|
+
/**
|
|
763
|
+
* Max Impressions Per User
|
|
764
|
+
* @description Max impressions per user
|
|
765
|
+
*/
|
|
766
|
+
max_impressions_per_user?: number | null;
|
|
767
|
+
/**
|
|
768
|
+
* Priority
|
|
769
|
+
* @description Priority (0-100, higher = shown first)
|
|
770
|
+
* @default 0
|
|
771
|
+
*/
|
|
772
|
+
priority: number;
|
|
773
|
+
/**
|
|
774
|
+
* Locale
|
|
775
|
+
* @description Primary locale
|
|
776
|
+
* @default en-US
|
|
777
|
+
*/
|
|
778
|
+
locale: string;
|
|
779
|
+
/**
|
|
780
|
+
* Translations
|
|
781
|
+
* @description Multi-language content
|
|
782
|
+
*/
|
|
783
|
+
translations?: {
|
|
784
|
+
[key: string]: unknown;
|
|
785
|
+
} | null;
|
|
786
|
+
/**
|
|
787
|
+
* Status
|
|
788
|
+
* @description Status: draft, active, paused
|
|
789
|
+
* @default draft
|
|
790
|
+
*/
|
|
791
|
+
status: string;
|
|
792
|
+
/**
|
|
793
|
+
* Company Id
|
|
794
|
+
* @description Optional company scoping
|
|
795
|
+
*/
|
|
796
|
+
company_id?: number | null;
|
|
797
|
+
};
|
|
798
|
+
/**
|
|
799
|
+
* AnnouncementUpdateRequest
|
|
800
|
+
* @description Request model for updating announcement (admin).
|
|
801
|
+
*/
|
|
802
|
+
AnnouncementUpdateRequest: {
|
|
803
|
+
/** Title */
|
|
804
|
+
title?: string | null;
|
|
805
|
+
/** Message */
|
|
806
|
+
message?: string | null;
|
|
807
|
+
/** Display Type */
|
|
808
|
+
display_type?: string | null;
|
|
809
|
+
/** Theme */
|
|
810
|
+
theme?: string | null;
|
|
811
|
+
/** Background Color */
|
|
812
|
+
background_color?: string | null;
|
|
813
|
+
/** Text Color */
|
|
814
|
+
text_color?: string | null;
|
|
815
|
+
/** Icon */
|
|
816
|
+
icon?: string | null;
|
|
817
|
+
/** Cta Text */
|
|
818
|
+
cta_text?: string | null;
|
|
819
|
+
/** Cta Url */
|
|
820
|
+
cta_url?: string | null;
|
|
821
|
+
/** Cta Style */
|
|
822
|
+
cta_style?: string | null;
|
|
823
|
+
/** Context Type */
|
|
824
|
+
context_type?: string | null;
|
|
825
|
+
/** Context Id */
|
|
826
|
+
context_id?: number | null;
|
|
827
|
+
/** Target Audience */
|
|
828
|
+
target_audience?: string | null;
|
|
829
|
+
/** Target User Ids */
|
|
830
|
+
target_user_ids?: number[] | null;
|
|
831
|
+
/** Target Segments */
|
|
832
|
+
target_segments?: {
|
|
833
|
+
[key: string]: unknown;
|
|
834
|
+
} | null;
|
|
835
|
+
/** Target Pages */
|
|
836
|
+
target_pages?: string[] | null;
|
|
837
|
+
/** Starts At */
|
|
838
|
+
starts_at?: string | null;
|
|
839
|
+
/** Ends At */
|
|
840
|
+
ends_at?: string | null;
|
|
841
|
+
/** Schedule Timezone */
|
|
842
|
+
schedule_timezone?: string | null;
|
|
843
|
+
/** Time Window Start */
|
|
844
|
+
time_window_start?: string | null;
|
|
845
|
+
/** Time Window End */
|
|
846
|
+
time_window_end?: string | null;
|
|
847
|
+
/** Is Dismissible */
|
|
848
|
+
is_dismissible?: boolean | null;
|
|
849
|
+
/** Requires Acknowledgment */
|
|
850
|
+
requires_acknowledgment?: boolean | null;
|
|
851
|
+
/** Max Impressions Per User */
|
|
852
|
+
max_impressions_per_user?: number | null;
|
|
853
|
+
/** Priority */
|
|
854
|
+
priority?: number | null;
|
|
855
|
+
/** Locale */
|
|
856
|
+
locale?: string | null;
|
|
857
|
+
/** Translations */
|
|
858
|
+
translations?: {
|
|
859
|
+
[key: string]: unknown;
|
|
860
|
+
} | null;
|
|
861
|
+
/** Status */
|
|
862
|
+
status?: string | null;
|
|
863
|
+
};
|
|
864
|
+
};
|
|
865
|
+
responses: never;
|
|
866
|
+
parameters: never;
|
|
867
|
+
requestBodies: never;
|
|
868
|
+
headers: never;
|
|
869
|
+
pathItems: never;
|
|
870
|
+
}
|
|
871
|
+
export type $defs = Record<string, never>;
|
|
872
|
+
export interface operations {
|
|
873
|
+
listAnnouncements: {
|
|
874
|
+
parameters: {
|
|
875
|
+
query?: {
|
|
876
|
+
/** @description Filter by status: active, all */
|
|
877
|
+
status?: string | null;
|
|
878
|
+
/** @description Context type: course, product, bundle, etc. */
|
|
879
|
+
context_type?: string | null;
|
|
880
|
+
/** @description Context entity ID */
|
|
881
|
+
context_id?: number | null;
|
|
882
|
+
/** @description Display type: bar_top, modal, card, etc. */
|
|
883
|
+
display_type?: string | null;
|
|
884
|
+
/** @description Current page route */
|
|
885
|
+
page_route?: string | null;
|
|
886
|
+
};
|
|
887
|
+
header?: {
|
|
888
|
+
authorization?: string | null;
|
|
889
|
+
"X-Guest-Session-ID"?: string | null;
|
|
890
|
+
};
|
|
891
|
+
path?: never;
|
|
892
|
+
cookie?: never;
|
|
893
|
+
};
|
|
894
|
+
requestBody?: never;
|
|
895
|
+
responses: {
|
|
896
|
+
/** @description Successful Response */
|
|
897
|
+
200: {
|
|
898
|
+
headers: {
|
|
899
|
+
[name: string]: unknown;
|
|
900
|
+
};
|
|
901
|
+
content: {
|
|
902
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
903
|
+
};
|
|
904
|
+
};
|
|
905
|
+
/** @description Bad Request */
|
|
906
|
+
400: {
|
|
907
|
+
headers: {
|
|
908
|
+
[name: string]: unknown;
|
|
909
|
+
};
|
|
910
|
+
content: {
|
|
911
|
+
/**
|
|
912
|
+
* @example {
|
|
913
|
+
* "status": "error",
|
|
914
|
+
* "message": "An error occurred",
|
|
915
|
+
* "message_code": "GENERIC_ERROR",
|
|
916
|
+
* "metadata": {
|
|
917
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
918
|
+
* "requestId": "uuid",
|
|
919
|
+
* "traceId": "uuid",
|
|
920
|
+
* "version": "v1",
|
|
921
|
+
* "executionTime": 0,
|
|
922
|
+
* "language": "en-US",
|
|
923
|
+
* "links": [
|
|
924
|
+
* {
|
|
925
|
+
* "rel": "self",
|
|
926
|
+
* "href": "/v1/cart/items",
|
|
927
|
+
* "method": "POST"
|
|
928
|
+
* }
|
|
929
|
+
* ]
|
|
930
|
+
* },
|
|
931
|
+
* "error": {
|
|
932
|
+
* "type": "https://{your-domain}/errors/client-error",
|
|
933
|
+
* "code": "GENERIC_ERROR",
|
|
934
|
+
* "title": "Client Error",
|
|
935
|
+
* "status": 400,
|
|
936
|
+
* "detail": "An error occurred",
|
|
937
|
+
* "instance": "/v1/cart/items",
|
|
938
|
+
* "extensions": {
|
|
939
|
+
* "message_code": "GENERIC_ERROR",
|
|
940
|
+
* "invalid_params": []
|
|
941
|
+
* }
|
|
942
|
+
* }
|
|
943
|
+
* }
|
|
944
|
+
*/
|
|
945
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
946
|
+
};
|
|
947
|
+
};
|
|
948
|
+
/** @description Unprocessable Entity */
|
|
949
|
+
422: {
|
|
950
|
+
headers: {
|
|
951
|
+
[name: string]: unknown;
|
|
952
|
+
};
|
|
953
|
+
content: {
|
|
954
|
+
/**
|
|
955
|
+
* @example {
|
|
956
|
+
* "status": "error",
|
|
957
|
+
* "message": "One or more input fields are invalid",
|
|
958
|
+
* "message_code": "INVALID_INPUT",
|
|
959
|
+
* "metadata": {
|
|
960
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
961
|
+
* "requestId": "uuid",
|
|
962
|
+
* "traceId": "uuid",
|
|
963
|
+
* "version": "v1",
|
|
964
|
+
* "executionTime": 0,
|
|
965
|
+
* "language": "en-US",
|
|
966
|
+
* "links": [
|
|
967
|
+
* {
|
|
968
|
+
* "rel": "self",
|
|
969
|
+
* "href": "/v1/cart/items",
|
|
970
|
+
* "method": "POST"
|
|
971
|
+
* }
|
|
972
|
+
* ]
|
|
973
|
+
* },
|
|
974
|
+
* "error": {
|
|
975
|
+
* "type": "https://{your-domain}/errors/invalid-input",
|
|
976
|
+
* "code": "INVALID_INPUT",
|
|
977
|
+
* "title": "Invalid Input",
|
|
978
|
+
* "status": 422,
|
|
979
|
+
* "detail": "One or more input fields are invalid",
|
|
980
|
+
* "instance": "/v1/cart/items",
|
|
981
|
+
* "extensions": {
|
|
982
|
+
* "message_code": "INVALID_INPUT",
|
|
983
|
+
* "invalid_params": [
|
|
984
|
+
* {
|
|
985
|
+
* "field": "items[0].quantity",
|
|
986
|
+
* "error": "Input should be greater than or equal to 1"
|
|
987
|
+
* }
|
|
988
|
+
* ]
|
|
989
|
+
* }
|
|
990
|
+
* }
|
|
991
|
+
* }
|
|
992
|
+
*/
|
|
993
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
994
|
+
};
|
|
995
|
+
};
|
|
996
|
+
/** @description Too Many Requests */
|
|
997
|
+
429: {
|
|
998
|
+
headers: {
|
|
999
|
+
[name: string]: unknown;
|
|
1000
|
+
};
|
|
1001
|
+
content: {
|
|
1002
|
+
/**
|
|
1003
|
+
* @example {
|
|
1004
|
+
* "status": "error",
|
|
1005
|
+
* "message": "Too many requests",
|
|
1006
|
+
* "message_code": "RATE_LIMIT_EXCEEDED",
|
|
1007
|
+
* "metadata": {
|
|
1008
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
1009
|
+
* "requestId": "uuid",
|
|
1010
|
+
* "traceId": "uuid",
|
|
1011
|
+
* "version": "v1",
|
|
1012
|
+
* "executionTime": 0,
|
|
1013
|
+
* "language": "en-US",
|
|
1014
|
+
* "links": [
|
|
1015
|
+
* {
|
|
1016
|
+
* "rel": "self",
|
|
1017
|
+
* "href": "/v1/cart/items",
|
|
1018
|
+
* "method": "POST"
|
|
1019
|
+
* }
|
|
1020
|
+
* ]
|
|
1021
|
+
* },
|
|
1022
|
+
* "error": {
|
|
1023
|
+
* "type": "https://{your-domain}/errors/rate-limit-exceeded",
|
|
1024
|
+
* "code": "RATE_LIMIT_EXCEEDED",
|
|
1025
|
+
* "title": "Rate Limit Exceeded",
|
|
1026
|
+
* "status": 429,
|
|
1027
|
+
* "detail": "Too many requests",
|
|
1028
|
+
* "instance": "/v1/cart/items",
|
|
1029
|
+
* "extensions": {
|
|
1030
|
+
* "message_code": "RATE_LIMIT_EXCEEDED",
|
|
1031
|
+
* "invalid_params": []
|
|
1032
|
+
* }
|
|
1033
|
+
* }
|
|
1034
|
+
* }
|
|
1035
|
+
*/
|
|
1036
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
1037
|
+
};
|
|
1038
|
+
};
|
|
1039
|
+
/** @description Internal Server Error */
|
|
1040
|
+
500: {
|
|
1041
|
+
headers: {
|
|
1042
|
+
[name: string]: unknown;
|
|
1043
|
+
};
|
|
1044
|
+
content: {
|
|
1045
|
+
/**
|
|
1046
|
+
* @example {
|
|
1047
|
+
* "status": "error",
|
|
1048
|
+
* "message": "An unexpected error occurred",
|
|
1049
|
+
* "message_code": "SERVER_ERROR",
|
|
1050
|
+
* "metadata": {
|
|
1051
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
1052
|
+
* "requestId": "uuid",
|
|
1053
|
+
* "traceId": "uuid",
|
|
1054
|
+
* "version": "v1",
|
|
1055
|
+
* "executionTime": 0,
|
|
1056
|
+
* "language": "en-US",
|
|
1057
|
+
* "links": [
|
|
1058
|
+
* {
|
|
1059
|
+
* "rel": "self",
|
|
1060
|
+
* "href": "/v1/cart/items",
|
|
1061
|
+
* "method": "POST"
|
|
1062
|
+
* }
|
|
1063
|
+
* ]
|
|
1064
|
+
* },
|
|
1065
|
+
* "error": {
|
|
1066
|
+
* "type": "https://{your-domain}/errors/server-error",
|
|
1067
|
+
* "code": "SERVER_ERROR",
|
|
1068
|
+
* "title": "Server Error",
|
|
1069
|
+
* "status": 500,
|
|
1070
|
+
* "detail": "An unexpected error occurred",
|
|
1071
|
+
* "instance": "/v1/cart/items",
|
|
1072
|
+
* "extensions": {
|
|
1073
|
+
* "message_code": "SERVER_ERROR",
|
|
1074
|
+
* "invalid_params": []
|
|
1075
|
+
* }
|
|
1076
|
+
* }
|
|
1077
|
+
* }
|
|
1078
|
+
*/
|
|
1079
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
1080
|
+
};
|
|
1081
|
+
};
|
|
1082
|
+
};
|
|
1083
|
+
};
|
|
1084
|
+
createAnnouncementInteraction: {
|
|
1085
|
+
parameters: {
|
|
1086
|
+
query?: never;
|
|
1087
|
+
header?: {
|
|
1088
|
+
authorization?: string | null;
|
|
1089
|
+
"X-Guest-Session-ID"?: string | null;
|
|
1090
|
+
};
|
|
1091
|
+
path: {
|
|
1092
|
+
announcement_id: string;
|
|
1093
|
+
};
|
|
1094
|
+
cookie?: never;
|
|
1095
|
+
};
|
|
1096
|
+
requestBody: {
|
|
1097
|
+
content: {
|
|
1098
|
+
"application/json": components["schemas"]["TrackInteractionRequest"];
|
|
1099
|
+
};
|
|
1100
|
+
};
|
|
1101
|
+
responses: {
|
|
1102
|
+
/** @description Successful Response */
|
|
1103
|
+
200: {
|
|
1104
|
+
headers: {
|
|
1105
|
+
[name: string]: unknown;
|
|
1106
|
+
};
|
|
1107
|
+
content: {
|
|
1108
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
1109
|
+
};
|
|
1110
|
+
};
|
|
1111
|
+
/** @description Bad Request */
|
|
1112
|
+
400: {
|
|
1113
|
+
headers: {
|
|
1114
|
+
[name: string]: unknown;
|
|
1115
|
+
};
|
|
1116
|
+
content: {
|
|
1117
|
+
/**
|
|
1118
|
+
* @example {
|
|
1119
|
+
* "status": "error",
|
|
1120
|
+
* "message": "An error occurred",
|
|
1121
|
+
* "message_code": "GENERIC_ERROR",
|
|
1122
|
+
* "metadata": {
|
|
1123
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
1124
|
+
* "requestId": "uuid",
|
|
1125
|
+
* "traceId": "uuid",
|
|
1126
|
+
* "version": "v1",
|
|
1127
|
+
* "executionTime": 0,
|
|
1128
|
+
* "language": "en-US",
|
|
1129
|
+
* "links": [
|
|
1130
|
+
* {
|
|
1131
|
+
* "rel": "self",
|
|
1132
|
+
* "href": "/v1/cart/items",
|
|
1133
|
+
* "method": "POST"
|
|
1134
|
+
* }
|
|
1135
|
+
* ]
|
|
1136
|
+
* },
|
|
1137
|
+
* "error": {
|
|
1138
|
+
* "type": "https://{your-domain}/errors/client-error",
|
|
1139
|
+
* "code": "GENERIC_ERROR",
|
|
1140
|
+
* "title": "Client Error",
|
|
1141
|
+
* "status": 400,
|
|
1142
|
+
* "detail": "An error occurred",
|
|
1143
|
+
* "instance": "/v1/cart/items",
|
|
1144
|
+
* "extensions": {
|
|
1145
|
+
* "message_code": "GENERIC_ERROR",
|
|
1146
|
+
* "invalid_params": []
|
|
1147
|
+
* }
|
|
1148
|
+
* }
|
|
1149
|
+
* }
|
|
1150
|
+
*/
|
|
1151
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
1152
|
+
};
|
|
1153
|
+
};
|
|
1154
|
+
/** @description Unprocessable Entity */
|
|
1155
|
+
422: {
|
|
1156
|
+
headers: {
|
|
1157
|
+
[name: string]: unknown;
|
|
1158
|
+
};
|
|
1159
|
+
content: {
|
|
1160
|
+
/**
|
|
1161
|
+
* @example {
|
|
1162
|
+
* "status": "error",
|
|
1163
|
+
* "message": "One or more input fields are invalid",
|
|
1164
|
+
* "message_code": "INVALID_INPUT",
|
|
1165
|
+
* "metadata": {
|
|
1166
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
1167
|
+
* "requestId": "uuid",
|
|
1168
|
+
* "traceId": "uuid",
|
|
1169
|
+
* "version": "v1",
|
|
1170
|
+
* "executionTime": 0,
|
|
1171
|
+
* "language": "en-US",
|
|
1172
|
+
* "links": [
|
|
1173
|
+
* {
|
|
1174
|
+
* "rel": "self",
|
|
1175
|
+
* "href": "/v1/cart/items",
|
|
1176
|
+
* "method": "POST"
|
|
1177
|
+
* }
|
|
1178
|
+
* ]
|
|
1179
|
+
* },
|
|
1180
|
+
* "error": {
|
|
1181
|
+
* "type": "https://{your-domain}/errors/invalid-input",
|
|
1182
|
+
* "code": "INVALID_INPUT",
|
|
1183
|
+
* "title": "Invalid Input",
|
|
1184
|
+
* "status": 422,
|
|
1185
|
+
* "detail": "One or more input fields are invalid",
|
|
1186
|
+
* "instance": "/v1/cart/items",
|
|
1187
|
+
* "extensions": {
|
|
1188
|
+
* "message_code": "INVALID_INPUT",
|
|
1189
|
+
* "invalid_params": [
|
|
1190
|
+
* {
|
|
1191
|
+
* "field": "items[0].quantity",
|
|
1192
|
+
* "error": "Input should be greater than or equal to 1"
|
|
1193
|
+
* }
|
|
1194
|
+
* ]
|
|
1195
|
+
* }
|
|
1196
|
+
* }
|
|
1197
|
+
* }
|
|
1198
|
+
*/
|
|
1199
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
1200
|
+
};
|
|
1201
|
+
};
|
|
1202
|
+
/** @description Too Many Requests */
|
|
1203
|
+
429: {
|
|
1204
|
+
headers: {
|
|
1205
|
+
[name: string]: unknown;
|
|
1206
|
+
};
|
|
1207
|
+
content: {
|
|
1208
|
+
/**
|
|
1209
|
+
* @example {
|
|
1210
|
+
* "status": "error",
|
|
1211
|
+
* "message": "Too many requests",
|
|
1212
|
+
* "message_code": "RATE_LIMIT_EXCEEDED",
|
|
1213
|
+
* "metadata": {
|
|
1214
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
1215
|
+
* "requestId": "uuid",
|
|
1216
|
+
* "traceId": "uuid",
|
|
1217
|
+
* "version": "v1",
|
|
1218
|
+
* "executionTime": 0,
|
|
1219
|
+
* "language": "en-US",
|
|
1220
|
+
* "links": [
|
|
1221
|
+
* {
|
|
1222
|
+
* "rel": "self",
|
|
1223
|
+
* "href": "/v1/cart/items",
|
|
1224
|
+
* "method": "POST"
|
|
1225
|
+
* }
|
|
1226
|
+
* ]
|
|
1227
|
+
* },
|
|
1228
|
+
* "error": {
|
|
1229
|
+
* "type": "https://{your-domain}/errors/rate-limit-exceeded",
|
|
1230
|
+
* "code": "RATE_LIMIT_EXCEEDED",
|
|
1231
|
+
* "title": "Rate Limit Exceeded",
|
|
1232
|
+
* "status": 429,
|
|
1233
|
+
* "detail": "Too many requests",
|
|
1234
|
+
* "instance": "/v1/cart/items",
|
|
1235
|
+
* "extensions": {
|
|
1236
|
+
* "message_code": "RATE_LIMIT_EXCEEDED",
|
|
1237
|
+
* "invalid_params": []
|
|
1238
|
+
* }
|
|
1239
|
+
* }
|
|
1240
|
+
* }
|
|
1241
|
+
*/
|
|
1242
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
1243
|
+
};
|
|
1244
|
+
};
|
|
1245
|
+
/** @description Internal Server Error */
|
|
1246
|
+
500: {
|
|
1247
|
+
headers: {
|
|
1248
|
+
[name: string]: unknown;
|
|
1249
|
+
};
|
|
1250
|
+
content: {
|
|
1251
|
+
/**
|
|
1252
|
+
* @example {
|
|
1253
|
+
* "status": "error",
|
|
1254
|
+
* "message": "An unexpected error occurred",
|
|
1255
|
+
* "message_code": "SERVER_ERROR",
|
|
1256
|
+
* "metadata": {
|
|
1257
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
1258
|
+
* "requestId": "uuid",
|
|
1259
|
+
* "traceId": "uuid",
|
|
1260
|
+
* "version": "v1",
|
|
1261
|
+
* "executionTime": 0,
|
|
1262
|
+
* "language": "en-US",
|
|
1263
|
+
* "links": [
|
|
1264
|
+
* {
|
|
1265
|
+
* "rel": "self",
|
|
1266
|
+
* "href": "/v1/cart/items",
|
|
1267
|
+
* "method": "POST"
|
|
1268
|
+
* }
|
|
1269
|
+
* ]
|
|
1270
|
+
* },
|
|
1271
|
+
* "error": {
|
|
1272
|
+
* "type": "https://{your-domain}/errors/server-error",
|
|
1273
|
+
* "code": "SERVER_ERROR",
|
|
1274
|
+
* "title": "Server Error",
|
|
1275
|
+
* "status": 500,
|
|
1276
|
+
* "detail": "An unexpected error occurred",
|
|
1277
|
+
* "instance": "/v1/cart/items",
|
|
1278
|
+
* "extensions": {
|
|
1279
|
+
* "message_code": "SERVER_ERROR",
|
|
1280
|
+
* "invalid_params": []
|
|
1281
|
+
* }
|
|
1282
|
+
* }
|
|
1283
|
+
* }
|
|
1284
|
+
*/
|
|
1285
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
1286
|
+
};
|
|
1287
|
+
};
|
|
1288
|
+
};
|
|
1289
|
+
};
|
|
1290
|
+
listAnnouncementsAdmin: {
|
|
1291
|
+
parameters: {
|
|
1292
|
+
query?: {
|
|
1293
|
+
/** @description Filter by status: draft, active, paused, ended, archived */
|
|
1294
|
+
status?: string | null;
|
|
1295
|
+
/** @description Filter by context type */
|
|
1296
|
+
context_type?: string | null;
|
|
1297
|
+
/** @description Filter by display type */
|
|
1298
|
+
display_type?: string | null;
|
|
1299
|
+
/** @description Page number (1-based) */
|
|
1300
|
+
page?: number;
|
|
1301
|
+
/** @description Items per page (1–100, default 20) */
|
|
1302
|
+
limit?: number;
|
|
1303
|
+
};
|
|
1304
|
+
header?: {
|
|
1305
|
+
authorization?: string | null;
|
|
1306
|
+
};
|
|
1307
|
+
path?: never;
|
|
1308
|
+
cookie?: never;
|
|
1309
|
+
};
|
|
1310
|
+
requestBody?: never;
|
|
1311
|
+
responses: {
|
|
1312
|
+
/** @description Successful Response */
|
|
1313
|
+
200: {
|
|
1314
|
+
headers: {
|
|
1315
|
+
[name: string]: unknown;
|
|
1316
|
+
};
|
|
1317
|
+
content: {
|
|
1318
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
1319
|
+
};
|
|
1320
|
+
};
|
|
1321
|
+
/** @description Bad Request */
|
|
1322
|
+
400: {
|
|
1323
|
+
headers: {
|
|
1324
|
+
[name: string]: unknown;
|
|
1325
|
+
};
|
|
1326
|
+
content: {
|
|
1327
|
+
/**
|
|
1328
|
+
* @example {
|
|
1329
|
+
* "status": "error",
|
|
1330
|
+
* "message": "An error occurred",
|
|
1331
|
+
* "message_code": "GENERIC_ERROR",
|
|
1332
|
+
* "metadata": {
|
|
1333
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
1334
|
+
* "requestId": "uuid",
|
|
1335
|
+
* "traceId": "uuid",
|
|
1336
|
+
* "version": "v1",
|
|
1337
|
+
* "executionTime": 0,
|
|
1338
|
+
* "language": "en-US",
|
|
1339
|
+
* "links": [
|
|
1340
|
+
* {
|
|
1341
|
+
* "rel": "self",
|
|
1342
|
+
* "href": "/v1/cart/items",
|
|
1343
|
+
* "method": "POST"
|
|
1344
|
+
* }
|
|
1345
|
+
* ]
|
|
1346
|
+
* },
|
|
1347
|
+
* "error": {
|
|
1348
|
+
* "type": "https://{your-domain}/errors/client-error",
|
|
1349
|
+
* "code": "GENERIC_ERROR",
|
|
1350
|
+
* "title": "Client Error",
|
|
1351
|
+
* "status": 400,
|
|
1352
|
+
* "detail": "An error occurred",
|
|
1353
|
+
* "instance": "/v1/cart/items",
|
|
1354
|
+
* "extensions": {
|
|
1355
|
+
* "message_code": "GENERIC_ERROR",
|
|
1356
|
+
* "invalid_params": []
|
|
1357
|
+
* }
|
|
1358
|
+
* }
|
|
1359
|
+
* }
|
|
1360
|
+
*/
|
|
1361
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
1362
|
+
};
|
|
1363
|
+
};
|
|
1364
|
+
/** @description Unprocessable Entity */
|
|
1365
|
+
422: {
|
|
1366
|
+
headers: {
|
|
1367
|
+
[name: string]: unknown;
|
|
1368
|
+
};
|
|
1369
|
+
content: {
|
|
1370
|
+
/**
|
|
1371
|
+
* @example {
|
|
1372
|
+
* "status": "error",
|
|
1373
|
+
* "message": "One or more input fields are invalid",
|
|
1374
|
+
* "message_code": "INVALID_INPUT",
|
|
1375
|
+
* "metadata": {
|
|
1376
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
1377
|
+
* "requestId": "uuid",
|
|
1378
|
+
* "traceId": "uuid",
|
|
1379
|
+
* "version": "v1",
|
|
1380
|
+
* "executionTime": 0,
|
|
1381
|
+
* "language": "en-US",
|
|
1382
|
+
* "links": [
|
|
1383
|
+
* {
|
|
1384
|
+
* "rel": "self",
|
|
1385
|
+
* "href": "/v1/cart/items",
|
|
1386
|
+
* "method": "POST"
|
|
1387
|
+
* }
|
|
1388
|
+
* ]
|
|
1389
|
+
* },
|
|
1390
|
+
* "error": {
|
|
1391
|
+
* "type": "https://{your-domain}/errors/invalid-input",
|
|
1392
|
+
* "code": "INVALID_INPUT",
|
|
1393
|
+
* "title": "Invalid Input",
|
|
1394
|
+
* "status": 422,
|
|
1395
|
+
* "detail": "One or more input fields are invalid",
|
|
1396
|
+
* "instance": "/v1/cart/items",
|
|
1397
|
+
* "extensions": {
|
|
1398
|
+
* "message_code": "INVALID_INPUT",
|
|
1399
|
+
* "invalid_params": [
|
|
1400
|
+
* {
|
|
1401
|
+
* "field": "items[0].quantity",
|
|
1402
|
+
* "error": "Input should be greater than or equal to 1"
|
|
1403
|
+
* }
|
|
1404
|
+
* ]
|
|
1405
|
+
* }
|
|
1406
|
+
* }
|
|
1407
|
+
* }
|
|
1408
|
+
*/
|
|
1409
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
1410
|
+
};
|
|
1411
|
+
};
|
|
1412
|
+
/** @description Too Many Requests */
|
|
1413
|
+
429: {
|
|
1414
|
+
headers: {
|
|
1415
|
+
[name: string]: unknown;
|
|
1416
|
+
};
|
|
1417
|
+
content: {
|
|
1418
|
+
/**
|
|
1419
|
+
* @example {
|
|
1420
|
+
* "status": "error",
|
|
1421
|
+
* "message": "Too many requests",
|
|
1422
|
+
* "message_code": "RATE_LIMIT_EXCEEDED",
|
|
1423
|
+
* "metadata": {
|
|
1424
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
1425
|
+
* "requestId": "uuid",
|
|
1426
|
+
* "traceId": "uuid",
|
|
1427
|
+
* "version": "v1",
|
|
1428
|
+
* "executionTime": 0,
|
|
1429
|
+
* "language": "en-US",
|
|
1430
|
+
* "links": [
|
|
1431
|
+
* {
|
|
1432
|
+
* "rel": "self",
|
|
1433
|
+
* "href": "/v1/cart/items",
|
|
1434
|
+
* "method": "POST"
|
|
1435
|
+
* }
|
|
1436
|
+
* ]
|
|
1437
|
+
* },
|
|
1438
|
+
* "error": {
|
|
1439
|
+
* "type": "https://{your-domain}/errors/rate-limit-exceeded",
|
|
1440
|
+
* "code": "RATE_LIMIT_EXCEEDED",
|
|
1441
|
+
* "title": "Rate Limit Exceeded",
|
|
1442
|
+
* "status": 429,
|
|
1443
|
+
* "detail": "Too many requests",
|
|
1444
|
+
* "instance": "/v1/cart/items",
|
|
1445
|
+
* "extensions": {
|
|
1446
|
+
* "message_code": "RATE_LIMIT_EXCEEDED",
|
|
1447
|
+
* "invalid_params": []
|
|
1448
|
+
* }
|
|
1449
|
+
* }
|
|
1450
|
+
* }
|
|
1451
|
+
*/
|
|
1452
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
1453
|
+
};
|
|
1454
|
+
};
|
|
1455
|
+
/** @description Internal Server Error */
|
|
1456
|
+
500: {
|
|
1457
|
+
headers: {
|
|
1458
|
+
[name: string]: unknown;
|
|
1459
|
+
};
|
|
1460
|
+
content: {
|
|
1461
|
+
/**
|
|
1462
|
+
* @example {
|
|
1463
|
+
* "status": "error",
|
|
1464
|
+
* "message": "An unexpected error occurred",
|
|
1465
|
+
* "message_code": "SERVER_ERROR",
|
|
1466
|
+
* "metadata": {
|
|
1467
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
1468
|
+
* "requestId": "uuid",
|
|
1469
|
+
* "traceId": "uuid",
|
|
1470
|
+
* "version": "v1",
|
|
1471
|
+
* "executionTime": 0,
|
|
1472
|
+
* "language": "en-US",
|
|
1473
|
+
* "links": [
|
|
1474
|
+
* {
|
|
1475
|
+
* "rel": "self",
|
|
1476
|
+
* "href": "/v1/cart/items",
|
|
1477
|
+
* "method": "POST"
|
|
1478
|
+
* }
|
|
1479
|
+
* ]
|
|
1480
|
+
* },
|
|
1481
|
+
* "error": {
|
|
1482
|
+
* "type": "https://{your-domain}/errors/server-error",
|
|
1483
|
+
* "code": "SERVER_ERROR",
|
|
1484
|
+
* "title": "Server Error",
|
|
1485
|
+
* "status": 500,
|
|
1486
|
+
* "detail": "An unexpected error occurred",
|
|
1487
|
+
* "instance": "/v1/cart/items",
|
|
1488
|
+
* "extensions": {
|
|
1489
|
+
* "message_code": "SERVER_ERROR",
|
|
1490
|
+
* "invalid_params": []
|
|
1491
|
+
* }
|
|
1492
|
+
* }
|
|
1493
|
+
* }
|
|
1494
|
+
*/
|
|
1495
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
1496
|
+
};
|
|
1497
|
+
};
|
|
1498
|
+
};
|
|
1499
|
+
};
|
|
1500
|
+
createAnnouncement: {
|
|
1501
|
+
parameters: {
|
|
1502
|
+
query?: never;
|
|
1503
|
+
header?: {
|
|
1504
|
+
authorization?: string | null;
|
|
1505
|
+
};
|
|
1506
|
+
path?: never;
|
|
1507
|
+
cookie?: never;
|
|
1508
|
+
};
|
|
1509
|
+
requestBody: {
|
|
1510
|
+
content: {
|
|
1511
|
+
"application/json": components["schemas"]["AnnouncementCreateRequest"];
|
|
1512
|
+
};
|
|
1513
|
+
};
|
|
1514
|
+
responses: {
|
|
1515
|
+
/** @description Successful Response */
|
|
1516
|
+
201: {
|
|
1517
|
+
headers: {
|
|
1518
|
+
[name: string]: unknown;
|
|
1519
|
+
};
|
|
1520
|
+
content: {
|
|
1521
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
1522
|
+
};
|
|
1523
|
+
};
|
|
1524
|
+
/** @description Bad Request */
|
|
1525
|
+
400: {
|
|
1526
|
+
headers: {
|
|
1527
|
+
[name: string]: unknown;
|
|
1528
|
+
};
|
|
1529
|
+
content: {
|
|
1530
|
+
/**
|
|
1531
|
+
* @example {
|
|
1532
|
+
* "status": "error",
|
|
1533
|
+
* "message": "An error occurred",
|
|
1534
|
+
* "message_code": "GENERIC_ERROR",
|
|
1535
|
+
* "metadata": {
|
|
1536
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
1537
|
+
* "requestId": "uuid",
|
|
1538
|
+
* "traceId": "uuid",
|
|
1539
|
+
* "version": "v1",
|
|
1540
|
+
* "executionTime": 0,
|
|
1541
|
+
* "language": "en-US",
|
|
1542
|
+
* "links": [
|
|
1543
|
+
* {
|
|
1544
|
+
* "rel": "self",
|
|
1545
|
+
* "href": "/v1/cart/items",
|
|
1546
|
+
* "method": "POST"
|
|
1547
|
+
* }
|
|
1548
|
+
* ]
|
|
1549
|
+
* },
|
|
1550
|
+
* "error": {
|
|
1551
|
+
* "type": "https://{your-domain}/errors/client-error",
|
|
1552
|
+
* "code": "GENERIC_ERROR",
|
|
1553
|
+
* "title": "Client Error",
|
|
1554
|
+
* "status": 400,
|
|
1555
|
+
* "detail": "An error occurred",
|
|
1556
|
+
* "instance": "/v1/cart/items",
|
|
1557
|
+
* "extensions": {
|
|
1558
|
+
* "message_code": "GENERIC_ERROR",
|
|
1559
|
+
* "invalid_params": []
|
|
1560
|
+
* }
|
|
1561
|
+
* }
|
|
1562
|
+
* }
|
|
1563
|
+
*/
|
|
1564
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
1565
|
+
};
|
|
1566
|
+
};
|
|
1567
|
+
/** @description Unprocessable Entity */
|
|
1568
|
+
422: {
|
|
1569
|
+
headers: {
|
|
1570
|
+
[name: string]: unknown;
|
|
1571
|
+
};
|
|
1572
|
+
content: {
|
|
1573
|
+
/**
|
|
1574
|
+
* @example {
|
|
1575
|
+
* "status": "error",
|
|
1576
|
+
* "message": "One or more input fields are invalid",
|
|
1577
|
+
* "message_code": "INVALID_INPUT",
|
|
1578
|
+
* "metadata": {
|
|
1579
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
1580
|
+
* "requestId": "uuid",
|
|
1581
|
+
* "traceId": "uuid",
|
|
1582
|
+
* "version": "v1",
|
|
1583
|
+
* "executionTime": 0,
|
|
1584
|
+
* "language": "en-US",
|
|
1585
|
+
* "links": [
|
|
1586
|
+
* {
|
|
1587
|
+
* "rel": "self",
|
|
1588
|
+
* "href": "/v1/cart/items",
|
|
1589
|
+
* "method": "POST"
|
|
1590
|
+
* }
|
|
1591
|
+
* ]
|
|
1592
|
+
* },
|
|
1593
|
+
* "error": {
|
|
1594
|
+
* "type": "https://{your-domain}/errors/invalid-input",
|
|
1595
|
+
* "code": "INVALID_INPUT",
|
|
1596
|
+
* "title": "Invalid Input",
|
|
1597
|
+
* "status": 422,
|
|
1598
|
+
* "detail": "One or more input fields are invalid",
|
|
1599
|
+
* "instance": "/v1/cart/items",
|
|
1600
|
+
* "extensions": {
|
|
1601
|
+
* "message_code": "INVALID_INPUT",
|
|
1602
|
+
* "invalid_params": [
|
|
1603
|
+
* {
|
|
1604
|
+
* "field": "items[0].quantity",
|
|
1605
|
+
* "error": "Input should be greater than or equal to 1"
|
|
1606
|
+
* }
|
|
1607
|
+
* ]
|
|
1608
|
+
* }
|
|
1609
|
+
* }
|
|
1610
|
+
* }
|
|
1611
|
+
*/
|
|
1612
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
1613
|
+
};
|
|
1614
|
+
};
|
|
1615
|
+
/** @description Too Many Requests */
|
|
1616
|
+
429: {
|
|
1617
|
+
headers: {
|
|
1618
|
+
[name: string]: unknown;
|
|
1619
|
+
};
|
|
1620
|
+
content: {
|
|
1621
|
+
/**
|
|
1622
|
+
* @example {
|
|
1623
|
+
* "status": "error",
|
|
1624
|
+
* "message": "Too many requests",
|
|
1625
|
+
* "message_code": "RATE_LIMIT_EXCEEDED",
|
|
1626
|
+
* "metadata": {
|
|
1627
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
1628
|
+
* "requestId": "uuid",
|
|
1629
|
+
* "traceId": "uuid",
|
|
1630
|
+
* "version": "v1",
|
|
1631
|
+
* "executionTime": 0,
|
|
1632
|
+
* "language": "en-US",
|
|
1633
|
+
* "links": [
|
|
1634
|
+
* {
|
|
1635
|
+
* "rel": "self",
|
|
1636
|
+
* "href": "/v1/cart/items",
|
|
1637
|
+
* "method": "POST"
|
|
1638
|
+
* }
|
|
1639
|
+
* ]
|
|
1640
|
+
* },
|
|
1641
|
+
* "error": {
|
|
1642
|
+
* "type": "https://{your-domain}/errors/rate-limit-exceeded",
|
|
1643
|
+
* "code": "RATE_LIMIT_EXCEEDED",
|
|
1644
|
+
* "title": "Rate Limit Exceeded",
|
|
1645
|
+
* "status": 429,
|
|
1646
|
+
* "detail": "Too many requests",
|
|
1647
|
+
* "instance": "/v1/cart/items",
|
|
1648
|
+
* "extensions": {
|
|
1649
|
+
* "message_code": "RATE_LIMIT_EXCEEDED",
|
|
1650
|
+
* "invalid_params": []
|
|
1651
|
+
* }
|
|
1652
|
+
* }
|
|
1653
|
+
* }
|
|
1654
|
+
*/
|
|
1655
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
1656
|
+
};
|
|
1657
|
+
};
|
|
1658
|
+
/** @description Internal Server Error */
|
|
1659
|
+
500: {
|
|
1660
|
+
headers: {
|
|
1661
|
+
[name: string]: unknown;
|
|
1662
|
+
};
|
|
1663
|
+
content: {
|
|
1664
|
+
/**
|
|
1665
|
+
* @example {
|
|
1666
|
+
* "status": "error",
|
|
1667
|
+
* "message": "An unexpected error occurred",
|
|
1668
|
+
* "message_code": "SERVER_ERROR",
|
|
1669
|
+
* "metadata": {
|
|
1670
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
1671
|
+
* "requestId": "uuid",
|
|
1672
|
+
* "traceId": "uuid",
|
|
1673
|
+
* "version": "v1",
|
|
1674
|
+
* "executionTime": 0,
|
|
1675
|
+
* "language": "en-US",
|
|
1676
|
+
* "links": [
|
|
1677
|
+
* {
|
|
1678
|
+
* "rel": "self",
|
|
1679
|
+
* "href": "/v1/cart/items",
|
|
1680
|
+
* "method": "POST"
|
|
1681
|
+
* }
|
|
1682
|
+
* ]
|
|
1683
|
+
* },
|
|
1684
|
+
* "error": {
|
|
1685
|
+
* "type": "https://{your-domain}/errors/server-error",
|
|
1686
|
+
* "code": "SERVER_ERROR",
|
|
1687
|
+
* "title": "Server Error",
|
|
1688
|
+
* "status": 500,
|
|
1689
|
+
* "detail": "An unexpected error occurred",
|
|
1690
|
+
* "instance": "/v1/cart/items",
|
|
1691
|
+
* "extensions": {
|
|
1692
|
+
* "message_code": "SERVER_ERROR",
|
|
1693
|
+
* "invalid_params": []
|
|
1694
|
+
* }
|
|
1695
|
+
* }
|
|
1696
|
+
* }
|
|
1697
|
+
*/
|
|
1698
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
1699
|
+
};
|
|
1700
|
+
};
|
|
1701
|
+
};
|
|
1702
|
+
};
|
|
1703
|
+
getAnnouncement: {
|
|
1704
|
+
parameters: {
|
|
1705
|
+
query?: never;
|
|
1706
|
+
header?: {
|
|
1707
|
+
authorization?: string | null;
|
|
1708
|
+
};
|
|
1709
|
+
path: {
|
|
1710
|
+
announcement_id: string;
|
|
1711
|
+
};
|
|
1712
|
+
cookie?: never;
|
|
1713
|
+
};
|
|
1714
|
+
requestBody?: never;
|
|
1715
|
+
responses: {
|
|
1716
|
+
/** @description Successful Response */
|
|
1717
|
+
200: {
|
|
1718
|
+
headers: {
|
|
1719
|
+
[name: string]: unknown;
|
|
1720
|
+
};
|
|
1721
|
+
content: {
|
|
1722
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
1723
|
+
};
|
|
1724
|
+
};
|
|
1725
|
+
/** @description Bad Request */
|
|
1726
|
+
400: {
|
|
1727
|
+
headers: {
|
|
1728
|
+
[name: string]: unknown;
|
|
1729
|
+
};
|
|
1730
|
+
content: {
|
|
1731
|
+
/**
|
|
1732
|
+
* @example {
|
|
1733
|
+
* "status": "error",
|
|
1734
|
+
* "message": "An error occurred",
|
|
1735
|
+
* "message_code": "GENERIC_ERROR",
|
|
1736
|
+
* "metadata": {
|
|
1737
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
1738
|
+
* "requestId": "uuid",
|
|
1739
|
+
* "traceId": "uuid",
|
|
1740
|
+
* "version": "v1",
|
|
1741
|
+
* "executionTime": 0,
|
|
1742
|
+
* "language": "en-US",
|
|
1743
|
+
* "links": [
|
|
1744
|
+
* {
|
|
1745
|
+
* "rel": "self",
|
|
1746
|
+
* "href": "/v1/cart/items",
|
|
1747
|
+
* "method": "POST"
|
|
1748
|
+
* }
|
|
1749
|
+
* ]
|
|
1750
|
+
* },
|
|
1751
|
+
* "error": {
|
|
1752
|
+
* "type": "https://{your-domain}/errors/client-error",
|
|
1753
|
+
* "code": "GENERIC_ERROR",
|
|
1754
|
+
* "title": "Client Error",
|
|
1755
|
+
* "status": 400,
|
|
1756
|
+
* "detail": "An error occurred",
|
|
1757
|
+
* "instance": "/v1/cart/items",
|
|
1758
|
+
* "extensions": {
|
|
1759
|
+
* "message_code": "GENERIC_ERROR",
|
|
1760
|
+
* "invalid_params": []
|
|
1761
|
+
* }
|
|
1762
|
+
* }
|
|
1763
|
+
* }
|
|
1764
|
+
*/
|
|
1765
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
1766
|
+
};
|
|
1767
|
+
};
|
|
1768
|
+
/** @description Unprocessable Entity */
|
|
1769
|
+
422: {
|
|
1770
|
+
headers: {
|
|
1771
|
+
[name: string]: unknown;
|
|
1772
|
+
};
|
|
1773
|
+
content: {
|
|
1774
|
+
/**
|
|
1775
|
+
* @example {
|
|
1776
|
+
* "status": "error",
|
|
1777
|
+
* "message": "One or more input fields are invalid",
|
|
1778
|
+
* "message_code": "INVALID_INPUT",
|
|
1779
|
+
* "metadata": {
|
|
1780
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
1781
|
+
* "requestId": "uuid",
|
|
1782
|
+
* "traceId": "uuid",
|
|
1783
|
+
* "version": "v1",
|
|
1784
|
+
* "executionTime": 0,
|
|
1785
|
+
* "language": "en-US",
|
|
1786
|
+
* "links": [
|
|
1787
|
+
* {
|
|
1788
|
+
* "rel": "self",
|
|
1789
|
+
* "href": "/v1/cart/items",
|
|
1790
|
+
* "method": "POST"
|
|
1791
|
+
* }
|
|
1792
|
+
* ]
|
|
1793
|
+
* },
|
|
1794
|
+
* "error": {
|
|
1795
|
+
* "type": "https://{your-domain}/errors/invalid-input",
|
|
1796
|
+
* "code": "INVALID_INPUT",
|
|
1797
|
+
* "title": "Invalid Input",
|
|
1798
|
+
* "status": 422,
|
|
1799
|
+
* "detail": "One or more input fields are invalid",
|
|
1800
|
+
* "instance": "/v1/cart/items",
|
|
1801
|
+
* "extensions": {
|
|
1802
|
+
* "message_code": "INVALID_INPUT",
|
|
1803
|
+
* "invalid_params": [
|
|
1804
|
+
* {
|
|
1805
|
+
* "field": "items[0].quantity",
|
|
1806
|
+
* "error": "Input should be greater than or equal to 1"
|
|
1807
|
+
* }
|
|
1808
|
+
* ]
|
|
1809
|
+
* }
|
|
1810
|
+
* }
|
|
1811
|
+
* }
|
|
1812
|
+
*/
|
|
1813
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
1814
|
+
};
|
|
1815
|
+
};
|
|
1816
|
+
/** @description Too Many Requests */
|
|
1817
|
+
429: {
|
|
1818
|
+
headers: {
|
|
1819
|
+
[name: string]: unknown;
|
|
1820
|
+
};
|
|
1821
|
+
content: {
|
|
1822
|
+
/**
|
|
1823
|
+
* @example {
|
|
1824
|
+
* "status": "error",
|
|
1825
|
+
* "message": "Too many requests",
|
|
1826
|
+
* "message_code": "RATE_LIMIT_EXCEEDED",
|
|
1827
|
+
* "metadata": {
|
|
1828
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
1829
|
+
* "requestId": "uuid",
|
|
1830
|
+
* "traceId": "uuid",
|
|
1831
|
+
* "version": "v1",
|
|
1832
|
+
* "executionTime": 0,
|
|
1833
|
+
* "language": "en-US",
|
|
1834
|
+
* "links": [
|
|
1835
|
+
* {
|
|
1836
|
+
* "rel": "self",
|
|
1837
|
+
* "href": "/v1/cart/items",
|
|
1838
|
+
* "method": "POST"
|
|
1839
|
+
* }
|
|
1840
|
+
* ]
|
|
1841
|
+
* },
|
|
1842
|
+
* "error": {
|
|
1843
|
+
* "type": "https://{your-domain}/errors/rate-limit-exceeded",
|
|
1844
|
+
* "code": "RATE_LIMIT_EXCEEDED",
|
|
1845
|
+
* "title": "Rate Limit Exceeded",
|
|
1846
|
+
* "status": 429,
|
|
1847
|
+
* "detail": "Too many requests",
|
|
1848
|
+
* "instance": "/v1/cart/items",
|
|
1849
|
+
* "extensions": {
|
|
1850
|
+
* "message_code": "RATE_LIMIT_EXCEEDED",
|
|
1851
|
+
* "invalid_params": []
|
|
1852
|
+
* }
|
|
1853
|
+
* }
|
|
1854
|
+
* }
|
|
1855
|
+
*/
|
|
1856
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
1857
|
+
};
|
|
1858
|
+
};
|
|
1859
|
+
/** @description Internal Server Error */
|
|
1860
|
+
500: {
|
|
1861
|
+
headers: {
|
|
1862
|
+
[name: string]: unknown;
|
|
1863
|
+
};
|
|
1864
|
+
content: {
|
|
1865
|
+
/**
|
|
1866
|
+
* @example {
|
|
1867
|
+
* "status": "error",
|
|
1868
|
+
* "message": "An unexpected error occurred",
|
|
1869
|
+
* "message_code": "SERVER_ERROR",
|
|
1870
|
+
* "metadata": {
|
|
1871
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
1872
|
+
* "requestId": "uuid",
|
|
1873
|
+
* "traceId": "uuid",
|
|
1874
|
+
* "version": "v1",
|
|
1875
|
+
* "executionTime": 0,
|
|
1876
|
+
* "language": "en-US",
|
|
1877
|
+
* "links": [
|
|
1878
|
+
* {
|
|
1879
|
+
* "rel": "self",
|
|
1880
|
+
* "href": "/v1/cart/items",
|
|
1881
|
+
* "method": "POST"
|
|
1882
|
+
* }
|
|
1883
|
+
* ]
|
|
1884
|
+
* },
|
|
1885
|
+
* "error": {
|
|
1886
|
+
* "type": "https://{your-domain}/errors/server-error",
|
|
1887
|
+
* "code": "SERVER_ERROR",
|
|
1888
|
+
* "title": "Server Error",
|
|
1889
|
+
* "status": 500,
|
|
1890
|
+
* "detail": "An unexpected error occurred",
|
|
1891
|
+
* "instance": "/v1/cart/items",
|
|
1892
|
+
* "extensions": {
|
|
1893
|
+
* "message_code": "SERVER_ERROR",
|
|
1894
|
+
* "invalid_params": []
|
|
1895
|
+
* }
|
|
1896
|
+
* }
|
|
1897
|
+
* }
|
|
1898
|
+
*/
|
|
1899
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
1900
|
+
};
|
|
1901
|
+
};
|
|
1902
|
+
};
|
|
1903
|
+
};
|
|
1904
|
+
deleteAnnouncement: {
|
|
1905
|
+
parameters: {
|
|
1906
|
+
query?: {
|
|
1907
|
+
/** @description Reason for deletion */
|
|
1908
|
+
deleted_reason?: string | null;
|
|
1909
|
+
};
|
|
1910
|
+
header?: {
|
|
1911
|
+
authorization?: string | null;
|
|
1912
|
+
};
|
|
1913
|
+
path: {
|
|
1914
|
+
announcement_id: string;
|
|
1915
|
+
};
|
|
1916
|
+
cookie?: never;
|
|
1917
|
+
};
|
|
1918
|
+
requestBody?: never;
|
|
1919
|
+
responses: {
|
|
1920
|
+
/** @description Successful Response */
|
|
1921
|
+
200: {
|
|
1922
|
+
headers: {
|
|
1923
|
+
[name: string]: unknown;
|
|
1924
|
+
};
|
|
1925
|
+
content: {
|
|
1926
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
1927
|
+
};
|
|
1928
|
+
};
|
|
1929
|
+
/** @description Bad Request */
|
|
1930
|
+
400: {
|
|
1931
|
+
headers: {
|
|
1932
|
+
[name: string]: unknown;
|
|
1933
|
+
};
|
|
1934
|
+
content: {
|
|
1935
|
+
/**
|
|
1936
|
+
* @example {
|
|
1937
|
+
* "status": "error",
|
|
1938
|
+
* "message": "An error occurred",
|
|
1939
|
+
* "message_code": "GENERIC_ERROR",
|
|
1940
|
+
* "metadata": {
|
|
1941
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
1942
|
+
* "requestId": "uuid",
|
|
1943
|
+
* "traceId": "uuid",
|
|
1944
|
+
* "version": "v1",
|
|
1945
|
+
* "executionTime": 0,
|
|
1946
|
+
* "language": "en-US",
|
|
1947
|
+
* "links": [
|
|
1948
|
+
* {
|
|
1949
|
+
* "rel": "self",
|
|
1950
|
+
* "href": "/v1/cart/items",
|
|
1951
|
+
* "method": "POST"
|
|
1952
|
+
* }
|
|
1953
|
+
* ]
|
|
1954
|
+
* },
|
|
1955
|
+
* "error": {
|
|
1956
|
+
* "type": "https://{your-domain}/errors/client-error",
|
|
1957
|
+
* "code": "GENERIC_ERROR",
|
|
1958
|
+
* "title": "Client Error",
|
|
1959
|
+
* "status": 400,
|
|
1960
|
+
* "detail": "An error occurred",
|
|
1961
|
+
* "instance": "/v1/cart/items",
|
|
1962
|
+
* "extensions": {
|
|
1963
|
+
* "message_code": "GENERIC_ERROR",
|
|
1964
|
+
* "invalid_params": []
|
|
1965
|
+
* }
|
|
1966
|
+
* }
|
|
1967
|
+
* }
|
|
1968
|
+
*/
|
|
1969
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
1970
|
+
};
|
|
1971
|
+
};
|
|
1972
|
+
/** @description Unprocessable Entity */
|
|
1973
|
+
422: {
|
|
1974
|
+
headers: {
|
|
1975
|
+
[name: string]: unknown;
|
|
1976
|
+
};
|
|
1977
|
+
content: {
|
|
1978
|
+
/**
|
|
1979
|
+
* @example {
|
|
1980
|
+
* "status": "error",
|
|
1981
|
+
* "message": "One or more input fields are invalid",
|
|
1982
|
+
* "message_code": "INVALID_INPUT",
|
|
1983
|
+
* "metadata": {
|
|
1984
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
1985
|
+
* "requestId": "uuid",
|
|
1986
|
+
* "traceId": "uuid",
|
|
1987
|
+
* "version": "v1",
|
|
1988
|
+
* "executionTime": 0,
|
|
1989
|
+
* "language": "en-US",
|
|
1990
|
+
* "links": [
|
|
1991
|
+
* {
|
|
1992
|
+
* "rel": "self",
|
|
1993
|
+
* "href": "/v1/cart/items",
|
|
1994
|
+
* "method": "POST"
|
|
1995
|
+
* }
|
|
1996
|
+
* ]
|
|
1997
|
+
* },
|
|
1998
|
+
* "error": {
|
|
1999
|
+
* "type": "https://{your-domain}/errors/invalid-input",
|
|
2000
|
+
* "code": "INVALID_INPUT",
|
|
2001
|
+
* "title": "Invalid Input",
|
|
2002
|
+
* "status": 422,
|
|
2003
|
+
* "detail": "One or more input fields are invalid",
|
|
2004
|
+
* "instance": "/v1/cart/items",
|
|
2005
|
+
* "extensions": {
|
|
2006
|
+
* "message_code": "INVALID_INPUT",
|
|
2007
|
+
* "invalid_params": [
|
|
2008
|
+
* {
|
|
2009
|
+
* "field": "items[0].quantity",
|
|
2010
|
+
* "error": "Input should be greater than or equal to 1"
|
|
2011
|
+
* }
|
|
2012
|
+
* ]
|
|
2013
|
+
* }
|
|
2014
|
+
* }
|
|
2015
|
+
* }
|
|
2016
|
+
*/
|
|
2017
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
2018
|
+
};
|
|
2019
|
+
};
|
|
2020
|
+
/** @description Too Many Requests */
|
|
2021
|
+
429: {
|
|
2022
|
+
headers: {
|
|
2023
|
+
[name: string]: unknown;
|
|
2024
|
+
};
|
|
2025
|
+
content: {
|
|
2026
|
+
/**
|
|
2027
|
+
* @example {
|
|
2028
|
+
* "status": "error",
|
|
2029
|
+
* "message": "Too many requests",
|
|
2030
|
+
* "message_code": "RATE_LIMIT_EXCEEDED",
|
|
2031
|
+
* "metadata": {
|
|
2032
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
2033
|
+
* "requestId": "uuid",
|
|
2034
|
+
* "traceId": "uuid",
|
|
2035
|
+
* "version": "v1",
|
|
2036
|
+
* "executionTime": 0,
|
|
2037
|
+
* "language": "en-US",
|
|
2038
|
+
* "links": [
|
|
2039
|
+
* {
|
|
2040
|
+
* "rel": "self",
|
|
2041
|
+
* "href": "/v1/cart/items",
|
|
2042
|
+
* "method": "POST"
|
|
2043
|
+
* }
|
|
2044
|
+
* ]
|
|
2045
|
+
* },
|
|
2046
|
+
* "error": {
|
|
2047
|
+
* "type": "https://{your-domain}/errors/rate-limit-exceeded",
|
|
2048
|
+
* "code": "RATE_LIMIT_EXCEEDED",
|
|
2049
|
+
* "title": "Rate Limit Exceeded",
|
|
2050
|
+
* "status": 429,
|
|
2051
|
+
* "detail": "Too many requests",
|
|
2052
|
+
* "instance": "/v1/cart/items",
|
|
2053
|
+
* "extensions": {
|
|
2054
|
+
* "message_code": "RATE_LIMIT_EXCEEDED",
|
|
2055
|
+
* "invalid_params": []
|
|
2056
|
+
* }
|
|
2057
|
+
* }
|
|
2058
|
+
* }
|
|
2059
|
+
*/
|
|
2060
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
2061
|
+
};
|
|
2062
|
+
};
|
|
2063
|
+
/** @description Internal Server Error */
|
|
2064
|
+
500: {
|
|
2065
|
+
headers: {
|
|
2066
|
+
[name: string]: unknown;
|
|
2067
|
+
};
|
|
2068
|
+
content: {
|
|
2069
|
+
/**
|
|
2070
|
+
* @example {
|
|
2071
|
+
* "status": "error",
|
|
2072
|
+
* "message": "An unexpected error occurred",
|
|
2073
|
+
* "message_code": "SERVER_ERROR",
|
|
2074
|
+
* "metadata": {
|
|
2075
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
2076
|
+
* "requestId": "uuid",
|
|
2077
|
+
* "traceId": "uuid",
|
|
2078
|
+
* "version": "v1",
|
|
2079
|
+
* "executionTime": 0,
|
|
2080
|
+
* "language": "en-US",
|
|
2081
|
+
* "links": [
|
|
2082
|
+
* {
|
|
2083
|
+
* "rel": "self",
|
|
2084
|
+
* "href": "/v1/cart/items",
|
|
2085
|
+
* "method": "POST"
|
|
2086
|
+
* }
|
|
2087
|
+
* ]
|
|
2088
|
+
* },
|
|
2089
|
+
* "error": {
|
|
2090
|
+
* "type": "https://{your-domain}/errors/server-error",
|
|
2091
|
+
* "code": "SERVER_ERROR",
|
|
2092
|
+
* "title": "Server Error",
|
|
2093
|
+
* "status": 500,
|
|
2094
|
+
* "detail": "An unexpected error occurred",
|
|
2095
|
+
* "instance": "/v1/cart/items",
|
|
2096
|
+
* "extensions": {
|
|
2097
|
+
* "message_code": "SERVER_ERROR",
|
|
2098
|
+
* "invalid_params": []
|
|
2099
|
+
* }
|
|
2100
|
+
* }
|
|
2101
|
+
* }
|
|
2102
|
+
*/
|
|
2103
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
2104
|
+
};
|
|
2105
|
+
};
|
|
2106
|
+
};
|
|
2107
|
+
};
|
|
2108
|
+
updateAnnouncement: {
|
|
2109
|
+
parameters: {
|
|
2110
|
+
query?: never;
|
|
2111
|
+
header?: {
|
|
2112
|
+
authorization?: string | null;
|
|
2113
|
+
};
|
|
2114
|
+
path: {
|
|
2115
|
+
announcement_id: string;
|
|
2116
|
+
};
|
|
2117
|
+
cookie?: never;
|
|
2118
|
+
};
|
|
2119
|
+
requestBody: {
|
|
2120
|
+
content: {
|
|
2121
|
+
"application/json": components["schemas"]["AnnouncementUpdateRequest"];
|
|
2122
|
+
};
|
|
2123
|
+
};
|
|
2124
|
+
responses: {
|
|
2125
|
+
/** @description Successful Response */
|
|
2126
|
+
200: {
|
|
2127
|
+
headers: {
|
|
2128
|
+
[name: string]: unknown;
|
|
2129
|
+
};
|
|
2130
|
+
content: {
|
|
2131
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
2132
|
+
};
|
|
2133
|
+
};
|
|
2134
|
+
/** @description Bad Request */
|
|
2135
|
+
400: {
|
|
2136
|
+
headers: {
|
|
2137
|
+
[name: string]: unknown;
|
|
2138
|
+
};
|
|
2139
|
+
content: {
|
|
2140
|
+
/**
|
|
2141
|
+
* @example {
|
|
2142
|
+
* "status": "error",
|
|
2143
|
+
* "message": "An error occurred",
|
|
2144
|
+
* "message_code": "GENERIC_ERROR",
|
|
2145
|
+
* "metadata": {
|
|
2146
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
2147
|
+
* "requestId": "uuid",
|
|
2148
|
+
* "traceId": "uuid",
|
|
2149
|
+
* "version": "v1",
|
|
2150
|
+
* "executionTime": 0,
|
|
2151
|
+
* "language": "en-US",
|
|
2152
|
+
* "links": [
|
|
2153
|
+
* {
|
|
2154
|
+
* "rel": "self",
|
|
2155
|
+
* "href": "/v1/cart/items",
|
|
2156
|
+
* "method": "POST"
|
|
2157
|
+
* }
|
|
2158
|
+
* ]
|
|
2159
|
+
* },
|
|
2160
|
+
* "error": {
|
|
2161
|
+
* "type": "https://{your-domain}/errors/client-error",
|
|
2162
|
+
* "code": "GENERIC_ERROR",
|
|
2163
|
+
* "title": "Client Error",
|
|
2164
|
+
* "status": 400,
|
|
2165
|
+
* "detail": "An error occurred",
|
|
2166
|
+
* "instance": "/v1/cart/items",
|
|
2167
|
+
* "extensions": {
|
|
2168
|
+
* "message_code": "GENERIC_ERROR",
|
|
2169
|
+
* "invalid_params": []
|
|
2170
|
+
* }
|
|
2171
|
+
* }
|
|
2172
|
+
* }
|
|
2173
|
+
*/
|
|
2174
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
2175
|
+
};
|
|
2176
|
+
};
|
|
2177
|
+
/** @description Unprocessable Entity */
|
|
2178
|
+
422: {
|
|
2179
|
+
headers: {
|
|
2180
|
+
[name: string]: unknown;
|
|
2181
|
+
};
|
|
2182
|
+
content: {
|
|
2183
|
+
/**
|
|
2184
|
+
* @example {
|
|
2185
|
+
* "status": "error",
|
|
2186
|
+
* "message": "One or more input fields are invalid",
|
|
2187
|
+
* "message_code": "INVALID_INPUT",
|
|
2188
|
+
* "metadata": {
|
|
2189
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
2190
|
+
* "requestId": "uuid",
|
|
2191
|
+
* "traceId": "uuid",
|
|
2192
|
+
* "version": "v1",
|
|
2193
|
+
* "executionTime": 0,
|
|
2194
|
+
* "language": "en-US",
|
|
2195
|
+
* "links": [
|
|
2196
|
+
* {
|
|
2197
|
+
* "rel": "self",
|
|
2198
|
+
* "href": "/v1/cart/items",
|
|
2199
|
+
* "method": "POST"
|
|
2200
|
+
* }
|
|
2201
|
+
* ]
|
|
2202
|
+
* },
|
|
2203
|
+
* "error": {
|
|
2204
|
+
* "type": "https://{your-domain}/errors/invalid-input",
|
|
2205
|
+
* "code": "INVALID_INPUT",
|
|
2206
|
+
* "title": "Invalid Input",
|
|
2207
|
+
* "status": 422,
|
|
2208
|
+
* "detail": "One or more input fields are invalid",
|
|
2209
|
+
* "instance": "/v1/cart/items",
|
|
2210
|
+
* "extensions": {
|
|
2211
|
+
* "message_code": "INVALID_INPUT",
|
|
2212
|
+
* "invalid_params": [
|
|
2213
|
+
* {
|
|
2214
|
+
* "field": "items[0].quantity",
|
|
2215
|
+
* "error": "Input should be greater than or equal to 1"
|
|
2216
|
+
* }
|
|
2217
|
+
* ]
|
|
2218
|
+
* }
|
|
2219
|
+
* }
|
|
2220
|
+
* }
|
|
2221
|
+
*/
|
|
2222
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
2223
|
+
};
|
|
2224
|
+
};
|
|
2225
|
+
/** @description Too Many Requests */
|
|
2226
|
+
429: {
|
|
2227
|
+
headers: {
|
|
2228
|
+
[name: string]: unknown;
|
|
2229
|
+
};
|
|
2230
|
+
content: {
|
|
2231
|
+
/**
|
|
2232
|
+
* @example {
|
|
2233
|
+
* "status": "error",
|
|
2234
|
+
* "message": "Too many requests",
|
|
2235
|
+
* "message_code": "RATE_LIMIT_EXCEEDED",
|
|
2236
|
+
* "metadata": {
|
|
2237
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
2238
|
+
* "requestId": "uuid",
|
|
2239
|
+
* "traceId": "uuid",
|
|
2240
|
+
* "version": "v1",
|
|
2241
|
+
* "executionTime": 0,
|
|
2242
|
+
* "language": "en-US",
|
|
2243
|
+
* "links": [
|
|
2244
|
+
* {
|
|
2245
|
+
* "rel": "self",
|
|
2246
|
+
* "href": "/v1/cart/items",
|
|
2247
|
+
* "method": "POST"
|
|
2248
|
+
* }
|
|
2249
|
+
* ]
|
|
2250
|
+
* },
|
|
2251
|
+
* "error": {
|
|
2252
|
+
* "type": "https://{your-domain}/errors/rate-limit-exceeded",
|
|
2253
|
+
* "code": "RATE_LIMIT_EXCEEDED",
|
|
2254
|
+
* "title": "Rate Limit Exceeded",
|
|
2255
|
+
* "status": 429,
|
|
2256
|
+
* "detail": "Too many requests",
|
|
2257
|
+
* "instance": "/v1/cart/items",
|
|
2258
|
+
* "extensions": {
|
|
2259
|
+
* "message_code": "RATE_LIMIT_EXCEEDED",
|
|
2260
|
+
* "invalid_params": []
|
|
2261
|
+
* }
|
|
2262
|
+
* }
|
|
2263
|
+
* }
|
|
2264
|
+
*/
|
|
2265
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
2266
|
+
};
|
|
2267
|
+
};
|
|
2268
|
+
/** @description Internal Server Error */
|
|
2269
|
+
500: {
|
|
2270
|
+
headers: {
|
|
2271
|
+
[name: string]: unknown;
|
|
2272
|
+
};
|
|
2273
|
+
content: {
|
|
2274
|
+
/**
|
|
2275
|
+
* @example {
|
|
2276
|
+
* "status": "error",
|
|
2277
|
+
* "message": "An unexpected error occurred",
|
|
2278
|
+
* "message_code": "SERVER_ERROR",
|
|
2279
|
+
* "metadata": {
|
|
2280
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
2281
|
+
* "requestId": "uuid",
|
|
2282
|
+
* "traceId": "uuid",
|
|
2283
|
+
* "version": "v1",
|
|
2284
|
+
* "executionTime": 0,
|
|
2285
|
+
* "language": "en-US",
|
|
2286
|
+
* "links": [
|
|
2287
|
+
* {
|
|
2288
|
+
* "rel": "self",
|
|
2289
|
+
* "href": "/v1/cart/items",
|
|
2290
|
+
* "method": "POST"
|
|
2291
|
+
* }
|
|
2292
|
+
* ]
|
|
2293
|
+
* },
|
|
2294
|
+
* "error": {
|
|
2295
|
+
* "type": "https://{your-domain}/errors/server-error",
|
|
2296
|
+
* "code": "SERVER_ERROR",
|
|
2297
|
+
* "title": "Server Error",
|
|
2298
|
+
* "status": 500,
|
|
2299
|
+
* "detail": "An unexpected error occurred",
|
|
2300
|
+
* "instance": "/v1/cart/items",
|
|
2301
|
+
* "extensions": {
|
|
2302
|
+
* "message_code": "SERVER_ERROR",
|
|
2303
|
+
* "invalid_params": []
|
|
2304
|
+
* }
|
|
2305
|
+
* }
|
|
2306
|
+
* }
|
|
2307
|
+
*/
|
|
2308
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
2309
|
+
};
|
|
2310
|
+
};
|
|
2311
|
+
};
|
|
2312
|
+
};
|
|
2313
|
+
createAnnouncementPublication: {
|
|
2314
|
+
parameters: {
|
|
2315
|
+
query?: never;
|
|
2316
|
+
header?: {
|
|
2317
|
+
authorization?: string | null;
|
|
2318
|
+
};
|
|
2319
|
+
path: {
|
|
2320
|
+
announcement_id: string;
|
|
2321
|
+
};
|
|
2322
|
+
cookie?: never;
|
|
2323
|
+
};
|
|
2324
|
+
requestBody?: never;
|
|
2325
|
+
responses: {
|
|
2326
|
+
/** @description Successful Response */
|
|
2327
|
+
200: {
|
|
2328
|
+
headers: {
|
|
2329
|
+
[name: string]: unknown;
|
|
2330
|
+
};
|
|
2331
|
+
content: {
|
|
2332
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
2333
|
+
};
|
|
2334
|
+
};
|
|
2335
|
+
/** @description Bad Request */
|
|
2336
|
+
400: {
|
|
2337
|
+
headers: {
|
|
2338
|
+
[name: string]: unknown;
|
|
2339
|
+
};
|
|
2340
|
+
content: {
|
|
2341
|
+
/**
|
|
2342
|
+
* @example {
|
|
2343
|
+
* "status": "error",
|
|
2344
|
+
* "message": "An error occurred",
|
|
2345
|
+
* "message_code": "GENERIC_ERROR",
|
|
2346
|
+
* "metadata": {
|
|
2347
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
2348
|
+
* "requestId": "uuid",
|
|
2349
|
+
* "traceId": "uuid",
|
|
2350
|
+
* "version": "v1",
|
|
2351
|
+
* "executionTime": 0,
|
|
2352
|
+
* "language": "en-US",
|
|
2353
|
+
* "links": [
|
|
2354
|
+
* {
|
|
2355
|
+
* "rel": "self",
|
|
2356
|
+
* "href": "/v1/cart/items",
|
|
2357
|
+
* "method": "POST"
|
|
2358
|
+
* }
|
|
2359
|
+
* ]
|
|
2360
|
+
* },
|
|
2361
|
+
* "error": {
|
|
2362
|
+
* "type": "https://{your-domain}/errors/client-error",
|
|
2363
|
+
* "code": "GENERIC_ERROR",
|
|
2364
|
+
* "title": "Client Error",
|
|
2365
|
+
* "status": 400,
|
|
2366
|
+
* "detail": "An error occurred",
|
|
2367
|
+
* "instance": "/v1/cart/items",
|
|
2368
|
+
* "extensions": {
|
|
2369
|
+
* "message_code": "GENERIC_ERROR",
|
|
2370
|
+
* "invalid_params": []
|
|
2371
|
+
* }
|
|
2372
|
+
* }
|
|
2373
|
+
* }
|
|
2374
|
+
*/
|
|
2375
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
2376
|
+
};
|
|
2377
|
+
};
|
|
2378
|
+
/** @description Unprocessable Entity */
|
|
2379
|
+
422: {
|
|
2380
|
+
headers: {
|
|
2381
|
+
[name: string]: unknown;
|
|
2382
|
+
};
|
|
2383
|
+
content: {
|
|
2384
|
+
/**
|
|
2385
|
+
* @example {
|
|
2386
|
+
* "status": "error",
|
|
2387
|
+
* "message": "One or more input fields are invalid",
|
|
2388
|
+
* "message_code": "INVALID_INPUT",
|
|
2389
|
+
* "metadata": {
|
|
2390
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
2391
|
+
* "requestId": "uuid",
|
|
2392
|
+
* "traceId": "uuid",
|
|
2393
|
+
* "version": "v1",
|
|
2394
|
+
* "executionTime": 0,
|
|
2395
|
+
* "language": "en-US",
|
|
2396
|
+
* "links": [
|
|
2397
|
+
* {
|
|
2398
|
+
* "rel": "self",
|
|
2399
|
+
* "href": "/v1/cart/items",
|
|
2400
|
+
* "method": "POST"
|
|
2401
|
+
* }
|
|
2402
|
+
* ]
|
|
2403
|
+
* },
|
|
2404
|
+
* "error": {
|
|
2405
|
+
* "type": "https://{your-domain}/errors/invalid-input",
|
|
2406
|
+
* "code": "INVALID_INPUT",
|
|
2407
|
+
* "title": "Invalid Input",
|
|
2408
|
+
* "status": 422,
|
|
2409
|
+
* "detail": "One or more input fields are invalid",
|
|
2410
|
+
* "instance": "/v1/cart/items",
|
|
2411
|
+
* "extensions": {
|
|
2412
|
+
* "message_code": "INVALID_INPUT",
|
|
2413
|
+
* "invalid_params": [
|
|
2414
|
+
* {
|
|
2415
|
+
* "field": "items[0].quantity",
|
|
2416
|
+
* "error": "Input should be greater than or equal to 1"
|
|
2417
|
+
* }
|
|
2418
|
+
* ]
|
|
2419
|
+
* }
|
|
2420
|
+
* }
|
|
2421
|
+
* }
|
|
2422
|
+
*/
|
|
2423
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
2424
|
+
};
|
|
2425
|
+
};
|
|
2426
|
+
/** @description Too Many Requests */
|
|
2427
|
+
429: {
|
|
2428
|
+
headers: {
|
|
2429
|
+
[name: string]: unknown;
|
|
2430
|
+
};
|
|
2431
|
+
content: {
|
|
2432
|
+
/**
|
|
2433
|
+
* @example {
|
|
2434
|
+
* "status": "error",
|
|
2435
|
+
* "message": "Too many requests",
|
|
2436
|
+
* "message_code": "RATE_LIMIT_EXCEEDED",
|
|
2437
|
+
* "metadata": {
|
|
2438
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
2439
|
+
* "requestId": "uuid",
|
|
2440
|
+
* "traceId": "uuid",
|
|
2441
|
+
* "version": "v1",
|
|
2442
|
+
* "executionTime": 0,
|
|
2443
|
+
* "language": "en-US",
|
|
2444
|
+
* "links": [
|
|
2445
|
+
* {
|
|
2446
|
+
* "rel": "self",
|
|
2447
|
+
* "href": "/v1/cart/items",
|
|
2448
|
+
* "method": "POST"
|
|
2449
|
+
* }
|
|
2450
|
+
* ]
|
|
2451
|
+
* },
|
|
2452
|
+
* "error": {
|
|
2453
|
+
* "type": "https://{your-domain}/errors/rate-limit-exceeded",
|
|
2454
|
+
* "code": "RATE_LIMIT_EXCEEDED",
|
|
2455
|
+
* "title": "Rate Limit Exceeded",
|
|
2456
|
+
* "status": 429,
|
|
2457
|
+
* "detail": "Too many requests",
|
|
2458
|
+
* "instance": "/v1/cart/items",
|
|
2459
|
+
* "extensions": {
|
|
2460
|
+
* "message_code": "RATE_LIMIT_EXCEEDED",
|
|
2461
|
+
* "invalid_params": []
|
|
2462
|
+
* }
|
|
2463
|
+
* }
|
|
2464
|
+
* }
|
|
2465
|
+
*/
|
|
2466
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
2467
|
+
};
|
|
2468
|
+
};
|
|
2469
|
+
/** @description Internal Server Error */
|
|
2470
|
+
500: {
|
|
2471
|
+
headers: {
|
|
2472
|
+
[name: string]: unknown;
|
|
2473
|
+
};
|
|
2474
|
+
content: {
|
|
2475
|
+
/**
|
|
2476
|
+
* @example {
|
|
2477
|
+
* "status": "error",
|
|
2478
|
+
* "message": "An unexpected error occurred",
|
|
2479
|
+
* "message_code": "SERVER_ERROR",
|
|
2480
|
+
* "metadata": {
|
|
2481
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
2482
|
+
* "requestId": "uuid",
|
|
2483
|
+
* "traceId": "uuid",
|
|
2484
|
+
* "version": "v1",
|
|
2485
|
+
* "executionTime": 0,
|
|
2486
|
+
* "language": "en-US",
|
|
2487
|
+
* "links": [
|
|
2488
|
+
* {
|
|
2489
|
+
* "rel": "self",
|
|
2490
|
+
* "href": "/v1/cart/items",
|
|
2491
|
+
* "method": "POST"
|
|
2492
|
+
* }
|
|
2493
|
+
* ]
|
|
2494
|
+
* },
|
|
2495
|
+
* "error": {
|
|
2496
|
+
* "type": "https://{your-domain}/errors/server-error",
|
|
2497
|
+
* "code": "SERVER_ERROR",
|
|
2498
|
+
* "title": "Server Error",
|
|
2499
|
+
* "status": 500,
|
|
2500
|
+
* "detail": "An unexpected error occurred",
|
|
2501
|
+
* "instance": "/v1/cart/items",
|
|
2502
|
+
* "extensions": {
|
|
2503
|
+
* "message_code": "SERVER_ERROR",
|
|
2504
|
+
* "invalid_params": []
|
|
2505
|
+
* }
|
|
2506
|
+
* }
|
|
2507
|
+
* }
|
|
2508
|
+
*/
|
|
2509
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
2510
|
+
};
|
|
2511
|
+
};
|
|
2512
|
+
};
|
|
2513
|
+
};
|
|
2514
|
+
createAnnouncementPause: {
|
|
2515
|
+
parameters: {
|
|
2516
|
+
query?: never;
|
|
2517
|
+
header?: {
|
|
2518
|
+
authorization?: string | null;
|
|
2519
|
+
};
|
|
2520
|
+
path: {
|
|
2521
|
+
announcement_id: string;
|
|
2522
|
+
};
|
|
2523
|
+
cookie?: never;
|
|
2524
|
+
};
|
|
2525
|
+
requestBody?: never;
|
|
2526
|
+
responses: {
|
|
2527
|
+
/** @description Successful Response */
|
|
2528
|
+
200: {
|
|
2529
|
+
headers: {
|
|
2530
|
+
[name: string]: unknown;
|
|
2531
|
+
};
|
|
2532
|
+
content: {
|
|
2533
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
2534
|
+
};
|
|
2535
|
+
};
|
|
2536
|
+
/** @description Bad Request */
|
|
2537
|
+
400: {
|
|
2538
|
+
headers: {
|
|
2539
|
+
[name: string]: unknown;
|
|
2540
|
+
};
|
|
2541
|
+
content: {
|
|
2542
|
+
/**
|
|
2543
|
+
* @example {
|
|
2544
|
+
* "status": "error",
|
|
2545
|
+
* "message": "An error occurred",
|
|
2546
|
+
* "message_code": "GENERIC_ERROR",
|
|
2547
|
+
* "metadata": {
|
|
2548
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
2549
|
+
* "requestId": "uuid",
|
|
2550
|
+
* "traceId": "uuid",
|
|
2551
|
+
* "version": "v1",
|
|
2552
|
+
* "executionTime": 0,
|
|
2553
|
+
* "language": "en-US",
|
|
2554
|
+
* "links": [
|
|
2555
|
+
* {
|
|
2556
|
+
* "rel": "self",
|
|
2557
|
+
* "href": "/v1/cart/items",
|
|
2558
|
+
* "method": "POST"
|
|
2559
|
+
* }
|
|
2560
|
+
* ]
|
|
2561
|
+
* },
|
|
2562
|
+
* "error": {
|
|
2563
|
+
* "type": "https://{your-domain}/errors/client-error",
|
|
2564
|
+
* "code": "GENERIC_ERROR",
|
|
2565
|
+
* "title": "Client Error",
|
|
2566
|
+
* "status": 400,
|
|
2567
|
+
* "detail": "An error occurred",
|
|
2568
|
+
* "instance": "/v1/cart/items",
|
|
2569
|
+
* "extensions": {
|
|
2570
|
+
* "message_code": "GENERIC_ERROR",
|
|
2571
|
+
* "invalid_params": []
|
|
2572
|
+
* }
|
|
2573
|
+
* }
|
|
2574
|
+
* }
|
|
2575
|
+
*/
|
|
2576
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
2577
|
+
};
|
|
2578
|
+
};
|
|
2579
|
+
/** @description Unprocessable Entity */
|
|
2580
|
+
422: {
|
|
2581
|
+
headers: {
|
|
2582
|
+
[name: string]: unknown;
|
|
2583
|
+
};
|
|
2584
|
+
content: {
|
|
2585
|
+
/**
|
|
2586
|
+
* @example {
|
|
2587
|
+
* "status": "error",
|
|
2588
|
+
* "message": "One or more input fields are invalid",
|
|
2589
|
+
* "message_code": "INVALID_INPUT",
|
|
2590
|
+
* "metadata": {
|
|
2591
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
2592
|
+
* "requestId": "uuid",
|
|
2593
|
+
* "traceId": "uuid",
|
|
2594
|
+
* "version": "v1",
|
|
2595
|
+
* "executionTime": 0,
|
|
2596
|
+
* "language": "en-US",
|
|
2597
|
+
* "links": [
|
|
2598
|
+
* {
|
|
2599
|
+
* "rel": "self",
|
|
2600
|
+
* "href": "/v1/cart/items",
|
|
2601
|
+
* "method": "POST"
|
|
2602
|
+
* }
|
|
2603
|
+
* ]
|
|
2604
|
+
* },
|
|
2605
|
+
* "error": {
|
|
2606
|
+
* "type": "https://{your-domain}/errors/invalid-input",
|
|
2607
|
+
* "code": "INVALID_INPUT",
|
|
2608
|
+
* "title": "Invalid Input",
|
|
2609
|
+
* "status": 422,
|
|
2610
|
+
* "detail": "One or more input fields are invalid",
|
|
2611
|
+
* "instance": "/v1/cart/items",
|
|
2612
|
+
* "extensions": {
|
|
2613
|
+
* "message_code": "INVALID_INPUT",
|
|
2614
|
+
* "invalid_params": [
|
|
2615
|
+
* {
|
|
2616
|
+
* "field": "items[0].quantity",
|
|
2617
|
+
* "error": "Input should be greater than or equal to 1"
|
|
2618
|
+
* }
|
|
2619
|
+
* ]
|
|
2620
|
+
* }
|
|
2621
|
+
* }
|
|
2622
|
+
* }
|
|
2623
|
+
*/
|
|
2624
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
2625
|
+
};
|
|
2626
|
+
};
|
|
2627
|
+
/** @description Too Many Requests */
|
|
2628
|
+
429: {
|
|
2629
|
+
headers: {
|
|
2630
|
+
[name: string]: unknown;
|
|
2631
|
+
};
|
|
2632
|
+
content: {
|
|
2633
|
+
/**
|
|
2634
|
+
* @example {
|
|
2635
|
+
* "status": "error",
|
|
2636
|
+
* "message": "Too many requests",
|
|
2637
|
+
* "message_code": "RATE_LIMIT_EXCEEDED",
|
|
2638
|
+
* "metadata": {
|
|
2639
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
2640
|
+
* "requestId": "uuid",
|
|
2641
|
+
* "traceId": "uuid",
|
|
2642
|
+
* "version": "v1",
|
|
2643
|
+
* "executionTime": 0,
|
|
2644
|
+
* "language": "en-US",
|
|
2645
|
+
* "links": [
|
|
2646
|
+
* {
|
|
2647
|
+
* "rel": "self",
|
|
2648
|
+
* "href": "/v1/cart/items",
|
|
2649
|
+
* "method": "POST"
|
|
2650
|
+
* }
|
|
2651
|
+
* ]
|
|
2652
|
+
* },
|
|
2653
|
+
* "error": {
|
|
2654
|
+
* "type": "https://{your-domain}/errors/rate-limit-exceeded",
|
|
2655
|
+
* "code": "RATE_LIMIT_EXCEEDED",
|
|
2656
|
+
* "title": "Rate Limit Exceeded",
|
|
2657
|
+
* "status": 429,
|
|
2658
|
+
* "detail": "Too many requests",
|
|
2659
|
+
* "instance": "/v1/cart/items",
|
|
2660
|
+
* "extensions": {
|
|
2661
|
+
* "message_code": "RATE_LIMIT_EXCEEDED",
|
|
2662
|
+
* "invalid_params": []
|
|
2663
|
+
* }
|
|
2664
|
+
* }
|
|
2665
|
+
* }
|
|
2666
|
+
*/
|
|
2667
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
2668
|
+
};
|
|
2669
|
+
};
|
|
2670
|
+
/** @description Internal Server Error */
|
|
2671
|
+
500: {
|
|
2672
|
+
headers: {
|
|
2673
|
+
[name: string]: unknown;
|
|
2674
|
+
};
|
|
2675
|
+
content: {
|
|
2676
|
+
/**
|
|
2677
|
+
* @example {
|
|
2678
|
+
* "status": "error",
|
|
2679
|
+
* "message": "An unexpected error occurred",
|
|
2680
|
+
* "message_code": "SERVER_ERROR",
|
|
2681
|
+
* "metadata": {
|
|
2682
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
2683
|
+
* "requestId": "uuid",
|
|
2684
|
+
* "traceId": "uuid",
|
|
2685
|
+
* "version": "v1",
|
|
2686
|
+
* "executionTime": 0,
|
|
2687
|
+
* "language": "en-US",
|
|
2688
|
+
* "links": [
|
|
2689
|
+
* {
|
|
2690
|
+
* "rel": "self",
|
|
2691
|
+
* "href": "/v1/cart/items",
|
|
2692
|
+
* "method": "POST"
|
|
2693
|
+
* }
|
|
2694
|
+
* ]
|
|
2695
|
+
* },
|
|
2696
|
+
* "error": {
|
|
2697
|
+
* "type": "https://{your-domain}/errors/server-error",
|
|
2698
|
+
* "code": "SERVER_ERROR",
|
|
2699
|
+
* "title": "Server Error",
|
|
2700
|
+
* "status": 500,
|
|
2701
|
+
* "detail": "An unexpected error occurred",
|
|
2702
|
+
* "instance": "/v1/cart/items",
|
|
2703
|
+
* "extensions": {
|
|
2704
|
+
* "message_code": "SERVER_ERROR",
|
|
2705
|
+
* "invalid_params": []
|
|
2706
|
+
* }
|
|
2707
|
+
* }
|
|
2708
|
+
* }
|
|
2709
|
+
*/
|
|
2710
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
2711
|
+
};
|
|
2712
|
+
};
|
|
2713
|
+
};
|
|
2714
|
+
};
|
|
2715
|
+
getAnnouncementAnalytics: {
|
|
2716
|
+
parameters: {
|
|
2717
|
+
query?: {
|
|
2718
|
+
/** @description Start date (YYYY-MM-DD) */
|
|
2719
|
+
start_date?: string | null;
|
|
2720
|
+
/** @description End date (YYYY-MM-DD) */
|
|
2721
|
+
end_date?: string | null;
|
|
2722
|
+
};
|
|
2723
|
+
header?: {
|
|
2724
|
+
authorization?: string | null;
|
|
2725
|
+
};
|
|
2726
|
+
path: {
|
|
2727
|
+
announcement_id: string;
|
|
2728
|
+
};
|
|
2729
|
+
cookie?: never;
|
|
2730
|
+
};
|
|
2731
|
+
requestBody?: never;
|
|
2732
|
+
responses: {
|
|
2733
|
+
/** @description Successful Response */
|
|
2734
|
+
200: {
|
|
2735
|
+
headers: {
|
|
2736
|
+
[name: string]: unknown;
|
|
2737
|
+
};
|
|
2738
|
+
content: {
|
|
2739
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
2740
|
+
};
|
|
2741
|
+
};
|
|
2742
|
+
/** @description Bad Request */
|
|
2743
|
+
400: {
|
|
2744
|
+
headers: {
|
|
2745
|
+
[name: string]: unknown;
|
|
2746
|
+
};
|
|
2747
|
+
content: {
|
|
2748
|
+
/**
|
|
2749
|
+
* @example {
|
|
2750
|
+
* "status": "error",
|
|
2751
|
+
* "message": "An error occurred",
|
|
2752
|
+
* "message_code": "GENERIC_ERROR",
|
|
2753
|
+
* "metadata": {
|
|
2754
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
2755
|
+
* "requestId": "uuid",
|
|
2756
|
+
* "traceId": "uuid",
|
|
2757
|
+
* "version": "v1",
|
|
2758
|
+
* "executionTime": 0,
|
|
2759
|
+
* "language": "en-US",
|
|
2760
|
+
* "links": [
|
|
2761
|
+
* {
|
|
2762
|
+
* "rel": "self",
|
|
2763
|
+
* "href": "/v1/cart/items",
|
|
2764
|
+
* "method": "POST"
|
|
2765
|
+
* }
|
|
2766
|
+
* ]
|
|
2767
|
+
* },
|
|
2768
|
+
* "error": {
|
|
2769
|
+
* "type": "https://{your-domain}/errors/client-error",
|
|
2770
|
+
* "code": "GENERIC_ERROR",
|
|
2771
|
+
* "title": "Client Error",
|
|
2772
|
+
* "status": 400,
|
|
2773
|
+
* "detail": "An error occurred",
|
|
2774
|
+
* "instance": "/v1/cart/items",
|
|
2775
|
+
* "extensions": {
|
|
2776
|
+
* "message_code": "GENERIC_ERROR",
|
|
2777
|
+
* "invalid_params": []
|
|
2778
|
+
* }
|
|
2779
|
+
* }
|
|
2780
|
+
* }
|
|
2781
|
+
*/
|
|
2782
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
2783
|
+
};
|
|
2784
|
+
};
|
|
2785
|
+
/** @description Unprocessable Entity */
|
|
2786
|
+
422: {
|
|
2787
|
+
headers: {
|
|
2788
|
+
[name: string]: unknown;
|
|
2789
|
+
};
|
|
2790
|
+
content: {
|
|
2791
|
+
/**
|
|
2792
|
+
* @example {
|
|
2793
|
+
* "status": "error",
|
|
2794
|
+
* "message": "One or more input fields are invalid",
|
|
2795
|
+
* "message_code": "INVALID_INPUT",
|
|
2796
|
+
* "metadata": {
|
|
2797
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
2798
|
+
* "requestId": "uuid",
|
|
2799
|
+
* "traceId": "uuid",
|
|
2800
|
+
* "version": "v1",
|
|
2801
|
+
* "executionTime": 0,
|
|
2802
|
+
* "language": "en-US",
|
|
2803
|
+
* "links": [
|
|
2804
|
+
* {
|
|
2805
|
+
* "rel": "self",
|
|
2806
|
+
* "href": "/v1/cart/items",
|
|
2807
|
+
* "method": "POST"
|
|
2808
|
+
* }
|
|
2809
|
+
* ]
|
|
2810
|
+
* },
|
|
2811
|
+
* "error": {
|
|
2812
|
+
* "type": "https://{your-domain}/errors/invalid-input",
|
|
2813
|
+
* "code": "INVALID_INPUT",
|
|
2814
|
+
* "title": "Invalid Input",
|
|
2815
|
+
* "status": 422,
|
|
2816
|
+
* "detail": "One or more input fields are invalid",
|
|
2817
|
+
* "instance": "/v1/cart/items",
|
|
2818
|
+
* "extensions": {
|
|
2819
|
+
* "message_code": "INVALID_INPUT",
|
|
2820
|
+
* "invalid_params": [
|
|
2821
|
+
* {
|
|
2822
|
+
* "field": "items[0].quantity",
|
|
2823
|
+
* "error": "Input should be greater than or equal to 1"
|
|
2824
|
+
* }
|
|
2825
|
+
* ]
|
|
2826
|
+
* }
|
|
2827
|
+
* }
|
|
2828
|
+
* }
|
|
2829
|
+
*/
|
|
2830
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
2831
|
+
};
|
|
2832
|
+
};
|
|
2833
|
+
/** @description Too Many Requests */
|
|
2834
|
+
429: {
|
|
2835
|
+
headers: {
|
|
2836
|
+
[name: string]: unknown;
|
|
2837
|
+
};
|
|
2838
|
+
content: {
|
|
2839
|
+
/**
|
|
2840
|
+
* @example {
|
|
2841
|
+
* "status": "error",
|
|
2842
|
+
* "message": "Too many requests",
|
|
2843
|
+
* "message_code": "RATE_LIMIT_EXCEEDED",
|
|
2844
|
+
* "metadata": {
|
|
2845
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
2846
|
+
* "requestId": "uuid",
|
|
2847
|
+
* "traceId": "uuid",
|
|
2848
|
+
* "version": "v1",
|
|
2849
|
+
* "executionTime": 0,
|
|
2850
|
+
* "language": "en-US",
|
|
2851
|
+
* "links": [
|
|
2852
|
+
* {
|
|
2853
|
+
* "rel": "self",
|
|
2854
|
+
* "href": "/v1/cart/items",
|
|
2855
|
+
* "method": "POST"
|
|
2856
|
+
* }
|
|
2857
|
+
* ]
|
|
2858
|
+
* },
|
|
2859
|
+
* "error": {
|
|
2860
|
+
* "type": "https://{your-domain}/errors/rate-limit-exceeded",
|
|
2861
|
+
* "code": "RATE_LIMIT_EXCEEDED",
|
|
2862
|
+
* "title": "Rate Limit Exceeded",
|
|
2863
|
+
* "status": 429,
|
|
2864
|
+
* "detail": "Too many requests",
|
|
2865
|
+
* "instance": "/v1/cart/items",
|
|
2866
|
+
* "extensions": {
|
|
2867
|
+
* "message_code": "RATE_LIMIT_EXCEEDED",
|
|
2868
|
+
* "invalid_params": []
|
|
2869
|
+
* }
|
|
2870
|
+
* }
|
|
2871
|
+
* }
|
|
2872
|
+
*/
|
|
2873
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
2874
|
+
};
|
|
2875
|
+
};
|
|
2876
|
+
/** @description Internal Server Error */
|
|
2877
|
+
500: {
|
|
2878
|
+
headers: {
|
|
2879
|
+
[name: string]: unknown;
|
|
2880
|
+
};
|
|
2881
|
+
content: {
|
|
2882
|
+
/**
|
|
2883
|
+
* @example {
|
|
2884
|
+
* "status": "error",
|
|
2885
|
+
* "message": "An unexpected error occurred",
|
|
2886
|
+
* "message_code": "SERVER_ERROR",
|
|
2887
|
+
* "metadata": {
|
|
2888
|
+
* "timestamp": "2025-08-05T18:38:57Z",
|
|
2889
|
+
* "requestId": "uuid",
|
|
2890
|
+
* "traceId": "uuid",
|
|
2891
|
+
* "version": "v1",
|
|
2892
|
+
* "executionTime": 0,
|
|
2893
|
+
* "language": "en-US",
|
|
2894
|
+
* "links": [
|
|
2895
|
+
* {
|
|
2896
|
+
* "rel": "self",
|
|
2897
|
+
* "href": "/v1/cart/items",
|
|
2898
|
+
* "method": "POST"
|
|
2899
|
+
* }
|
|
2900
|
+
* ]
|
|
2901
|
+
* },
|
|
2902
|
+
* "error": {
|
|
2903
|
+
* "type": "https://{your-domain}/errors/server-error",
|
|
2904
|
+
* "code": "SERVER_ERROR",
|
|
2905
|
+
* "title": "Server Error",
|
|
2906
|
+
* "status": 500,
|
|
2907
|
+
* "detail": "An unexpected error occurred",
|
|
2908
|
+
* "instance": "/v1/cart/items",
|
|
2909
|
+
* "extensions": {
|
|
2910
|
+
* "message_code": "SERVER_ERROR",
|
|
2911
|
+
* "invalid_params": []
|
|
2912
|
+
* }
|
|
2913
|
+
* }
|
|
2914
|
+
* }
|
|
2915
|
+
*/
|
|
2916
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
2917
|
+
};
|
|
2918
|
+
};
|
|
2919
|
+
};
|
|
2920
|
+
};
|
|
2921
|
+
}
|
|
2922
|
+
//# sourceMappingURL=generated.d.ts.map
|