@blezgo/api-sdk 0.1.0 → 0.1.2
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/client.d.ts +1 -1
- package/dist/account/client.d.ts.map +1 -1
- package/dist/account/generated.d.ts +214 -214
- package/dist/account/generated.d.ts.map +1 -1
- package/dist/account/index.d.ts +1 -1
- package/dist/account/index.d.ts.map +1 -1
- package/dist/account/index.js +1 -1
- package/dist/account/index.js.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/client.d.ts +1 -1
- package/dist/admin/client.d.ts.map +1 -1
- package/dist/admin/generated.d.ts +87 -87
- package/dist/admin/generated.d.ts.map +1 -1
- package/dist/admin/index.d.ts +1 -1
- package/dist/admin/index.d.ts.map +1 -1
- package/dist/admin/index.js +1 -1
- package/dist/admin/index.js.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/client.d.ts +1 -1
- package/dist/authentication/client.d.ts.map +1 -1
- package/dist/authentication/generated.d.ts +91 -91
- package/dist/authentication/generated.d.ts.map +1 -1
- package/dist/authentication/index.d.ts +1 -1
- package/dist/authentication/index.d.ts.map +1 -1
- package/dist/authentication/index.js +1 -1
- package/dist/authentication/index.js.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/client.d.ts +1 -1
- package/dist/cache/client.d.ts.map +1 -1
- package/dist/cache/generated.d.ts +24 -24
- package/dist/cache/generated.d.ts.map +1 -1
- package/dist/cache/index.d.ts +1 -1
- package/dist/cache/index.d.ts.map +1 -1
- package/dist/cache/index.js +1 -1
- package/dist/cache/index.js.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/client.d.ts +1 -1
- package/dist/config/client.d.ts.map +1 -1
- package/dist/config/generated.d.ts +62 -62
- package/dist/config/generated.d.ts.map +1 -1
- package/dist/config/index.d.ts +1 -1
- package/dist/config/index.d.ts.map +1 -1
- package/dist/config/index.js +1 -1
- package/dist/config/index.js.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/client.d.ts +1 -1
- package/dist/dashboard/client.d.ts.map +1 -1
- package/dist/dashboard/generated.d.ts +137 -137
- package/dist/dashboard/generated.d.ts.map +1 -1
- package/dist/dashboard/index.d.ts +1 -1
- package/dist/dashboard/index.d.ts.map +1 -1
- package/dist/dashboard/index.js +1 -1
- package/dist/dashboard/index.js.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/client.d.ts +1 -1
- package/dist/errors/client.d.ts.map +1 -1
- package/dist/errors/generated.d.ts +21 -21
- package/dist/errors/generated.d.ts.map +1 -1
- package/dist/errors/index.d.ts +1 -1
- package/dist/errors/index.d.ts.map +1 -1
- package/dist/errors/index.js +1 -1
- package/dist/errors/index.js.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 +68 -14
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +68 -14
- 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/client.d.ts +1 -1
- package/dist/internationalization/client.d.ts.map +1 -1
- package/dist/internationalization/generated.d.ts +21 -21
- package/dist/internationalization/generated.d.ts.map +1 -1
- package/dist/internationalization/index.d.ts +1 -1
- package/dist/internationalization/index.d.ts.map +1 -1
- package/dist/internationalization/index.js +1 -1
- package/dist/internationalization/index.js.map +1 -1
- package/dist/invitations/client.d.ts +1 -1
- package/dist/invitations/client.d.ts.map +1 -1
- package/dist/invitations/generated.d.ts +120 -120
- package/dist/invitations/generated.d.ts.map +1 -1
- package/dist/invitations/index.d.ts +1 -1
- package/dist/invitations/index.d.ts.map +1 -1
- package/dist/invitations/index.js +1 -1
- package/dist/invitations/index.js.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/client.d.ts +1 -1
- package/dist/registration/client.d.ts.map +1 -1
- package/dist/registration/generated.d.ts +170 -170
- package/dist/registration/generated.d.ts.map +1 -1
- package/dist/registration/index.d.ts +1 -1
- package/dist/registration/index.d.ts.map +1 -1
- package/dist/registration/index.js +1 -1
- package/dist/registration/index.js.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/client.d.ts +1 -1
- package/dist/role/client.d.ts.map +1 -1
- package/dist/role/generated.d.ts +220 -220
- package/dist/role/generated.d.ts.map +1 -1
- package/dist/role/index.d.ts +1 -1
- package/dist/role/index.d.ts.map +1 -1
- package/dist/role/index.js +1 -1
- package/dist/role/index.js.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/client.d.ts +1 -1
- package/dist/tenant/client.d.ts.map +1 -1
- package/dist/tenant/generated.d.ts +591 -591
- package/dist/tenant/generated.d.ts.map +1 -1
- package/dist/tenant/index.d.ts +1 -1
- package/dist/tenant/index.d.ts.map +1 -1
- package/dist/tenant/index.js +1 -1
- package/dist/tenant/index.js.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/client.d.ts +1 -1
- package/dist/tokens/client.d.ts.map +1 -1
- package/dist/tokens/generated.d.ts +64 -64
- package/dist/tokens/generated.d.ts.map +1 -1
- package/dist/tokens/index.d.ts +1 -1
- package/dist/tokens/index.d.ts.map +1 -1
- package/dist/tokens/index.js +1 -1
- package/dist/tokens/index.js.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/client.d.ts +1 -1
- package/dist/user/client.d.ts.map +1 -1
- package/dist/user/generated.d.ts +72 -72
- package/dist/user/generated.d.ts.map +1 -1
- package/dist/user/index.d.ts +1 -1
- package/dist/user/index.d.ts.map +1 -1
- package/dist/user/index.js +1 -1
- package/dist/user/index.js.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 +354 -19
|
@@ -0,0 +1,2053 @@
|
|
|
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/api-keys": {
|
|
7
|
+
parameters: {
|
|
8
|
+
query?: never;
|
|
9
|
+
header?: never;
|
|
10
|
+
path?: never;
|
|
11
|
+
cookie?: never;
|
|
12
|
+
};
|
|
13
|
+
/**
|
|
14
|
+
* List Api Keys
|
|
15
|
+
* @description **List API keys for the organization.**
|
|
16
|
+
*
|
|
17
|
+
* **Purpose**: Retrieve all API keys with optional filtering and pagination.
|
|
18
|
+
*
|
|
19
|
+
* **Query Parameters**:
|
|
20
|
+
* - environment: Filter by environment (development, test, live)
|
|
21
|
+
* - key_type: Filter by type (public, secret, restricted, webhook)
|
|
22
|
+
* - status: Filter by status (active, rotating, revoked)
|
|
23
|
+
* - page: Page number (default: 1)
|
|
24
|
+
* - page_size: Items per page (default: 50, max: 100)
|
|
25
|
+
*
|
|
26
|
+
* **Example Request**:
|
|
27
|
+
* ```
|
|
28
|
+
* GET /v1/api-keys?environment=live&key_type=public&page=1&page_size=20
|
|
29
|
+
* ```
|
|
30
|
+
*
|
|
31
|
+
* **Example Response**:
|
|
32
|
+
* ```json
|
|
33
|
+
* {
|
|
34
|
+
* "success": true,
|
|
35
|
+
* "data": {
|
|
36
|
+
* "keys": [
|
|
37
|
+
* {
|
|
38
|
+
* "api_client_id": "apicli_abc123...",
|
|
39
|
+
* "masked_key": "pk_live_***xyz",
|
|
40
|
+
* "client_name": "Production Frontend",
|
|
41
|
+
* "key_type": "public",
|
|
42
|
+
* "environment": "live",
|
|
43
|
+
* "status": "active",
|
|
44
|
+
* "created_at": "2026-02-01T00:00:00Z"
|
|
45
|
+
* }
|
|
46
|
+
* ],
|
|
47
|
+
* "total": 45,
|
|
48
|
+
* "page": 1,
|
|
49
|
+
* "page_size": 20
|
|
50
|
+
* }
|
|
51
|
+
* }
|
|
52
|
+
* ```
|
|
53
|
+
*
|
|
54
|
+
* **Performance**:
|
|
55
|
+
* - Target: < 50ms (with proper indexing)
|
|
56
|
+
* - Cached for 30 seconds
|
|
57
|
+
*
|
|
58
|
+
* **Authentication**: Required (api_keys.read.all permission)
|
|
59
|
+
* **Rate Limit**: 300 requests per minute per user
|
|
60
|
+
*
|
|
61
|
+
* **Response Codes**:
|
|
62
|
+
* - 200: Success
|
|
63
|
+
* - 400: Invalid query parameters
|
|
64
|
+
* - 401: Unauthorized
|
|
65
|
+
* - 403: Forbidden
|
|
66
|
+
* - 500: Server error
|
|
67
|
+
*/
|
|
68
|
+
get: operations["listApiKeys"];
|
|
69
|
+
put?: never;
|
|
70
|
+
/**
|
|
71
|
+
* Create Api Key
|
|
72
|
+
* @description **Create a new API key.**
|
|
73
|
+
*
|
|
74
|
+
* **Purpose**: Generate a secure API key for programmatic access to the platform.
|
|
75
|
+
*
|
|
76
|
+
* **Flow**:
|
|
77
|
+
* 1. Validate request data (key_type, environment, rate limits)
|
|
78
|
+
* 2. Generate cryptographically secure random key
|
|
79
|
+
* 3. Hash key with SHA-256 + per-key salt
|
|
80
|
+
* 4. Encrypt key for optional display (AES-256)
|
|
81
|
+
* 5. Store in database with metadata
|
|
82
|
+
* 6. Create audit log entry
|
|
83
|
+
* 7. Return key details with plaintext key (shown ONCE)
|
|
84
|
+
*
|
|
85
|
+
* **Example Request**:
|
|
86
|
+
* ```json
|
|
87
|
+
* POST /v1/api-keys
|
|
88
|
+
* {
|
|
89
|
+
* "client_name": "Production Frontend",
|
|
90
|
+
* "key_type": "public",
|
|
91
|
+
* "environment": "live",
|
|
92
|
+
* "scopes": ["orders:read", "products:read"],
|
|
93
|
+
* "rate_limit_per_minute": 100,
|
|
94
|
+
* "allowed_ips": ["203.0.113.0/24"],
|
|
95
|
+
* "expires_at": "2027-12-31T23:59:59Z"
|
|
96
|
+
* }
|
|
97
|
+
* ```
|
|
98
|
+
*
|
|
99
|
+
* **Example Response**:
|
|
100
|
+
* ```json
|
|
101
|
+
* {
|
|
102
|
+
* "success": true,
|
|
103
|
+
* "data": {
|
|
104
|
+
* "api_client_id": "apicli_abc123...",
|
|
105
|
+
* "plaintext_key": "pk_live_xyz789...",
|
|
106
|
+
* "masked_key": "pk_live_***9xyz",
|
|
107
|
+
* "key_type": "public",
|
|
108
|
+
* "environment": "live",
|
|
109
|
+
* "warning": "⚠️ STORE THIS KEY SECURELY - It will not be shown again"
|
|
110
|
+
* }
|
|
111
|
+
* }
|
|
112
|
+
* ```
|
|
113
|
+
*
|
|
114
|
+
* **Performance**:
|
|
115
|
+
* - Target: < 50ms (generation + hash + encrypt + DB + audit)
|
|
116
|
+
*
|
|
117
|
+
* **Authentication**: Required (api_keys.create.all permission)
|
|
118
|
+
* **Rate Limit**: 100 requests per hour per user
|
|
119
|
+
*
|
|
120
|
+
* **Response Codes**:
|
|
121
|
+
* - 201: API key created successfully
|
|
122
|
+
* - 400: Invalid request (validation errors)
|
|
123
|
+
* - 401: Unauthorized (missing/invalid credentials)
|
|
124
|
+
* - 403: Forbidden (insufficient permissions)
|
|
125
|
+
* - 500: Server error
|
|
126
|
+
*/
|
|
127
|
+
post: operations["createApiKey"];
|
|
128
|
+
delete?: never;
|
|
129
|
+
options?: never;
|
|
130
|
+
head?: never;
|
|
131
|
+
patch?: never;
|
|
132
|
+
trace?: never;
|
|
133
|
+
};
|
|
134
|
+
"/v1/api-keys/batch": {
|
|
135
|
+
parameters: {
|
|
136
|
+
query?: never;
|
|
137
|
+
header?: never;
|
|
138
|
+
path?: never;
|
|
139
|
+
cookie?: never;
|
|
140
|
+
};
|
|
141
|
+
get?: never;
|
|
142
|
+
put?: never;
|
|
143
|
+
/**
|
|
144
|
+
* Create Api Key Batch
|
|
145
|
+
* @description **Create multiple related API keys from a context template.**
|
|
146
|
+
*
|
|
147
|
+
* **Purpose**: Generate a complete key set for products requiring multiple key types
|
|
148
|
+
* (e.g., payment gateway: public key, secret key, webhook secret).
|
|
149
|
+
*
|
|
150
|
+
* **Flow**:
|
|
151
|
+
* 1. Load context template for product type
|
|
152
|
+
* 2. Generate key for each context (public_key, secret_key, etc.)
|
|
153
|
+
* 3. Group keys under single key_set_id
|
|
154
|
+
* 4. Return all keys with plaintext values (shown ONCE)
|
|
155
|
+
*
|
|
156
|
+
* **Example Request**:
|
|
157
|
+
* ```json
|
|
158
|
+
* POST /v1/api-keys/batch
|
|
159
|
+
* {
|
|
160
|
+
* "product_type": "payment_gateway",
|
|
161
|
+
* "environment": "live",
|
|
162
|
+
* "client_name": "Stripe Integration",
|
|
163
|
+
* "scopes": ["payments:write"],
|
|
164
|
+
* "rate_limit_per_minute": 200
|
|
165
|
+
* }
|
|
166
|
+
* ```
|
|
167
|
+
*
|
|
168
|
+
* **Example Response**:
|
|
169
|
+
* ```json
|
|
170
|
+
* {
|
|
171
|
+
* "success": true,
|
|
172
|
+
* "data": {
|
|
173
|
+
* "key_set_id": "keyset_abc123...",
|
|
174
|
+
* "product_type": "payment_gateway",
|
|
175
|
+
* "keys": {
|
|
176
|
+
* "public_key": {
|
|
177
|
+
* "api_client_id": "apicli_pk123...",
|
|
178
|
+
* "plaintext_key": "pk_live_...",
|
|
179
|
+
* "masked_key": "pk_live_***xyz"
|
|
180
|
+
* },
|
|
181
|
+
* "secret_key": {
|
|
182
|
+
* "api_client_id": "apicli_sk123...",
|
|
183
|
+
* "plaintext_key": "sk_live_...",
|
|
184
|
+
* "masked_key": "sk_live_***xyz"
|
|
185
|
+
* },
|
|
186
|
+
* "webhook_secret": {
|
|
187
|
+
* "api_client_id": "apicli_wsk123...",
|
|
188
|
+
* "plaintext_key": "wsk_...",
|
|
189
|
+
* "masked_key": "wsk_***xyz"
|
|
190
|
+
* }
|
|
191
|
+
* }
|
|
192
|
+
* }
|
|
193
|
+
* }
|
|
194
|
+
* ```
|
|
195
|
+
*
|
|
196
|
+
* **Authentication**: Required (api_keys.create.all permission)
|
|
197
|
+
* **Rate Limit**: 50 requests per hour per user
|
|
198
|
+
*
|
|
199
|
+
* **Response Codes**:
|
|
200
|
+
* - 201: Key set created successfully
|
|
201
|
+
* - 400: Invalid product_type or validation errors
|
|
202
|
+
* - 401: Unauthorized
|
|
203
|
+
* - 403: Forbidden
|
|
204
|
+
* - 404: Context template not found
|
|
205
|
+
* - 500: Server error
|
|
206
|
+
*/
|
|
207
|
+
post: operations["createApiKeyBatch"];
|
|
208
|
+
delete?: never;
|
|
209
|
+
options?: never;
|
|
210
|
+
head?: never;
|
|
211
|
+
patch?: never;
|
|
212
|
+
trace?: never;
|
|
213
|
+
};
|
|
214
|
+
"/v1/api-keys/{api_client_id}": {
|
|
215
|
+
parameters: {
|
|
216
|
+
query?: never;
|
|
217
|
+
header?: never;
|
|
218
|
+
path?: never;
|
|
219
|
+
cookie?: never;
|
|
220
|
+
};
|
|
221
|
+
/**
|
|
222
|
+
* Get Api Key
|
|
223
|
+
* @description **Get API key details by ID.**
|
|
224
|
+
*
|
|
225
|
+
* **Purpose**: Retrieve detailed information about a specific API key.
|
|
226
|
+
*
|
|
227
|
+
* **Example Request**:
|
|
228
|
+
* ```
|
|
229
|
+
* GET /v1/api-keys/apicli_abc123...
|
|
230
|
+
* ```
|
|
231
|
+
*
|
|
232
|
+
* **Example Response**:
|
|
233
|
+
* ```json
|
|
234
|
+
* {
|
|
235
|
+
* "success": true,
|
|
236
|
+
* "data": {
|
|
237
|
+
* "api_client_id": "apicli_abc123...",
|
|
238
|
+
* "masked_key": "pk_live_***xyz",
|
|
239
|
+
* "client_name": "Production Frontend",
|
|
240
|
+
* "key_type": "public",
|
|
241
|
+
* "environment": "live",
|
|
242
|
+
* "scopes": ["orders:read", "products:read"],
|
|
243
|
+
* "rate_limit_per_minute": 100,
|
|
244
|
+
* "usage_count": 15234,
|
|
245
|
+
* "last_used_at": "2026-02-05T10:30:00Z",
|
|
246
|
+
* "created_at": "2026-01-01T00:00:00Z"
|
|
247
|
+
* }
|
|
248
|
+
* }
|
|
249
|
+
* ```
|
|
250
|
+
*
|
|
251
|
+
* **Authentication**: Required (api_keys.read.all permission)
|
|
252
|
+
* **Rate Limit**: 600 requests per minute per user
|
|
253
|
+
*
|
|
254
|
+
* **Response Codes**:
|
|
255
|
+
* - 200: Success
|
|
256
|
+
* - 404: API key not found
|
|
257
|
+
* - 401: Unauthorized
|
|
258
|
+
* - 403: Forbidden
|
|
259
|
+
* - 500: Server error
|
|
260
|
+
*/
|
|
261
|
+
get: operations["getApiKey"];
|
|
262
|
+
put?: never;
|
|
263
|
+
post?: never;
|
|
264
|
+
delete?: never;
|
|
265
|
+
options?: never;
|
|
266
|
+
head?: never;
|
|
267
|
+
/**
|
|
268
|
+
* Update Api Key
|
|
269
|
+
* @description **Update API key metadata.**
|
|
270
|
+
*
|
|
271
|
+
* **Purpose**: Modify API key configuration (name, scopes, rate limits, etc.).
|
|
272
|
+
*
|
|
273
|
+
* **Note**: Cannot update key value or key_type. Use rotation endpoint for key changes.
|
|
274
|
+
*
|
|
275
|
+
* **Example Request**:
|
|
276
|
+
* ```json
|
|
277
|
+
* PUT /v1/api-keys/apicli_abc123...
|
|
278
|
+
* {
|
|
279
|
+
* "client_name": "Updated Frontend",
|
|
280
|
+
* "scopes": ["orders:read", "orders:write"],
|
|
281
|
+
* "rate_limit_per_minute": 200
|
|
282
|
+
* }
|
|
283
|
+
* ```
|
|
284
|
+
*
|
|
285
|
+
* **Example Response**:
|
|
286
|
+
* ```json
|
|
287
|
+
* {
|
|
288
|
+
* "success": true,
|
|
289
|
+
* "data": {
|
|
290
|
+
* "api_client_id": "apicli_abc123...",
|
|
291
|
+
* "client_name": "Updated Frontend",
|
|
292
|
+
* "scopes": ["orders:read", "orders:write"],
|
|
293
|
+
* "rate_limit_per_minute": 200
|
|
294
|
+
* },
|
|
295
|
+
* "message": "API key updated successfully"
|
|
296
|
+
* }
|
|
297
|
+
* ```
|
|
298
|
+
*
|
|
299
|
+
* **Authentication**: Required (api_keys.update.all permission)
|
|
300
|
+
* **Rate Limit**: 200 requests per minute per user
|
|
301
|
+
*
|
|
302
|
+
* **Response Codes**:
|
|
303
|
+
* - 200: Success
|
|
304
|
+
* - 400: Invalid update data
|
|
305
|
+
* - 404: API key not found
|
|
306
|
+
* - 401: Unauthorized
|
|
307
|
+
* - 403: Forbidden
|
|
308
|
+
* - 500: Server error
|
|
309
|
+
*/
|
|
310
|
+
patch: operations["updateApiKey"];
|
|
311
|
+
trace?: never;
|
|
312
|
+
};
|
|
313
|
+
"/v1/api-keys/{api_client_id}/revocations": {
|
|
314
|
+
parameters: {
|
|
315
|
+
query?: never;
|
|
316
|
+
header?: never;
|
|
317
|
+
path?: never;
|
|
318
|
+
cookie?: never;
|
|
319
|
+
};
|
|
320
|
+
get?: never;
|
|
321
|
+
put?: never;
|
|
322
|
+
/**
|
|
323
|
+
* Revoke Api Key
|
|
324
|
+
* @description **Revoke API key (soft delete).**
|
|
325
|
+
*
|
|
326
|
+
* **Purpose**: Permanently disable an API key. Cannot be undone.
|
|
327
|
+
*
|
|
328
|
+
* **Flow**:
|
|
329
|
+
* 1. Mark key as revoked (is_active = false)
|
|
330
|
+
* 2. Store revocation reason
|
|
331
|
+
* 3. Invalidate cache
|
|
332
|
+
* 4. Create audit log entry
|
|
333
|
+
* 5. Key immediately stops working
|
|
334
|
+
*
|
|
335
|
+
* **Example Request**:
|
|
336
|
+
* ```json
|
|
337
|
+
* DELETE /v1/api-keys/apicli_abc123...
|
|
338
|
+
* {
|
|
339
|
+
* "reason": "Security incident - potential key exposure"
|
|
340
|
+
* }
|
|
341
|
+
* ```
|
|
342
|
+
*
|
|
343
|
+
* **Example Response**:
|
|
344
|
+
* ```json
|
|
345
|
+
* {
|
|
346
|
+
* "success": true,
|
|
347
|
+
* "data": {
|
|
348
|
+
* "api_client_id": "apicli_abc123...",
|
|
349
|
+
* "status": "revoked",
|
|
350
|
+
* "revoked_at": "2026-02-05T12:00:00Z",
|
|
351
|
+
* "revoked_reason": "Security incident - potential key exposure"
|
|
352
|
+
* },
|
|
353
|
+
* "message": "API key revoked successfully"
|
|
354
|
+
* }
|
|
355
|
+
* ```
|
|
356
|
+
*
|
|
357
|
+
* **Authentication**: Required (api_keys.delete.all permission)
|
|
358
|
+
* **Rate Limit**: 100 requests per hour per user
|
|
359
|
+
*
|
|
360
|
+
* **Response Codes**:
|
|
361
|
+
* - 200: Success
|
|
362
|
+
* - 400: Missing reason
|
|
363
|
+
* - 404: API key not found
|
|
364
|
+
* - 401: Unauthorized
|
|
365
|
+
* - 403: Forbidden
|
|
366
|
+
* - 500: Server error
|
|
367
|
+
*/
|
|
368
|
+
post: operations["revokeApiKey"];
|
|
369
|
+
delete?: never;
|
|
370
|
+
options?: never;
|
|
371
|
+
head?: never;
|
|
372
|
+
patch?: never;
|
|
373
|
+
trace?: never;
|
|
374
|
+
};
|
|
375
|
+
"/v1/api-keys/{api_client_id}/rotations": {
|
|
376
|
+
parameters: {
|
|
377
|
+
query?: never;
|
|
378
|
+
header?: never;
|
|
379
|
+
path?: never;
|
|
380
|
+
cookie?: never;
|
|
381
|
+
};
|
|
382
|
+
get?: never;
|
|
383
|
+
put?: never;
|
|
384
|
+
/**
|
|
385
|
+
* Rotate Api Key
|
|
386
|
+
* @description **Rotate API key with grace period.**
|
|
387
|
+
*
|
|
388
|
+
* **Purpose**: Generate new key while keeping old key valid for transition period.
|
|
389
|
+
*
|
|
390
|
+
* **Flow**:
|
|
391
|
+
* 1. Generate new key (same configuration)
|
|
392
|
+
* 2. Mark old key as 'rotating' (still valid)
|
|
393
|
+
* 3. Set grace period (default: 30 days)
|
|
394
|
+
* 4. Old key auto-revokes after grace period
|
|
395
|
+
* 5. Return both keys
|
|
396
|
+
*
|
|
397
|
+
* **Example Request**:
|
|
398
|
+
* ```json
|
|
399
|
+
* POST /v1/api-keys/apicli_abc123.../rotate
|
|
400
|
+
* {
|
|
401
|
+
* "grace_period_days": 30,
|
|
402
|
+
* "reason": "Scheduled security rotation"
|
|
403
|
+
* }
|
|
404
|
+
* ```
|
|
405
|
+
*
|
|
406
|
+
* **Example Response**:
|
|
407
|
+
* ```json
|
|
408
|
+
* {
|
|
409
|
+
* "success": true,
|
|
410
|
+
* "data": {
|
|
411
|
+
* "old_key": {
|
|
412
|
+
* "api_client_id": "apicli_old123...",
|
|
413
|
+
* "masked_key": "pk_live_***old",
|
|
414
|
+
* "status": "rotating",
|
|
415
|
+
* "revoked_at": "2026-03-07T00:00:00Z"
|
|
416
|
+
* },
|
|
417
|
+
* "new_key": {
|
|
418
|
+
* "api_client_id": "apicli_new456...",
|
|
419
|
+
* "plaintext_key": "pk_live_new789...",
|
|
420
|
+
* "masked_key": "pk_live_***new",
|
|
421
|
+
* "status": "active",
|
|
422
|
+
* "warning": "⚠️ STORE THIS KEY SECURELY"
|
|
423
|
+
* },
|
|
424
|
+
* "grace_period_days": 30,
|
|
425
|
+
* "grace_period_ends_at": "2026-03-07T00:00:00Z"
|
|
426
|
+
* }
|
|
427
|
+
* }
|
|
428
|
+
* ```
|
|
429
|
+
*
|
|
430
|
+
* **Grace Period**:
|
|
431
|
+
* - Old key remains valid during grace period
|
|
432
|
+
* - New key active immediately
|
|
433
|
+
* - After grace period: old key auto-revoked
|
|
434
|
+
* - Update your applications before grace period expires
|
|
435
|
+
*
|
|
436
|
+
* **Performance**:
|
|
437
|
+
* - Target: < 100ms (new key generation + DB updates + cache invalidation)
|
|
438
|
+
*
|
|
439
|
+
* **Authentication**: Required (api_keys.rotate.all permission)
|
|
440
|
+
* **Rate Limit**: 50 requests per hour per user
|
|
441
|
+
*
|
|
442
|
+
* **Response Codes**:
|
|
443
|
+
* - 200: Rotation successful
|
|
444
|
+
* - 400: Invalid request (e.g., key already revoked)
|
|
445
|
+
* - 404: API key not found
|
|
446
|
+
* - 401: Unauthorized
|
|
447
|
+
* - 403: Forbidden
|
|
448
|
+
* - 500: Server error
|
|
449
|
+
*/
|
|
450
|
+
post: operations["rotateApiKey"];
|
|
451
|
+
delete?: never;
|
|
452
|
+
options?: never;
|
|
453
|
+
head?: never;
|
|
454
|
+
patch?: never;
|
|
455
|
+
trace?: never;
|
|
456
|
+
};
|
|
457
|
+
"/v1/api-key-sets/{key_set_id}/rotations": {
|
|
458
|
+
parameters: {
|
|
459
|
+
query?: never;
|
|
460
|
+
header?: never;
|
|
461
|
+
path?: never;
|
|
462
|
+
cookie?: never;
|
|
463
|
+
};
|
|
464
|
+
get?: never;
|
|
465
|
+
put?: never;
|
|
466
|
+
/**
|
|
467
|
+
* Rotate Api Key Set
|
|
468
|
+
* @description **Rotate all keys in a key set.**
|
|
469
|
+
*
|
|
470
|
+
* **Purpose**: Rotate multiple related keys simultaneously (e.g., payment gateway keys).
|
|
471
|
+
*
|
|
472
|
+
* **Flow**:
|
|
473
|
+
* 1. Get all keys in set
|
|
474
|
+
* 2. Rotate each key (generate new + mark old as rotating)
|
|
475
|
+
* 3. Same grace period for all keys
|
|
476
|
+
* 4. Return all old and new keys
|
|
477
|
+
*
|
|
478
|
+
* **Example Request**:
|
|
479
|
+
* ```json
|
|
480
|
+
* POST /v1/api-keys/sets/keyset_abc123.../rotate
|
|
481
|
+
* {
|
|
482
|
+
* "grace_period_days": 30,
|
|
483
|
+
* "reason": "Compliance requirement"
|
|
484
|
+
* }
|
|
485
|
+
* ```
|
|
486
|
+
*
|
|
487
|
+
* **Example Response**:
|
|
488
|
+
* ```json
|
|
489
|
+
* {
|
|
490
|
+
* "success": true,
|
|
491
|
+
* "data": {
|
|
492
|
+
* "key_set_id": "keyset_abc123...",
|
|
493
|
+
* "rotations": {
|
|
494
|
+
* "public_key": {
|
|
495
|
+
* "old_key": {...},
|
|
496
|
+
* "new_key": {...}
|
|
497
|
+
* },
|
|
498
|
+
* "secret_key": {
|
|
499
|
+
* "old_key": {...},
|
|
500
|
+
* "new_key": {...}
|
|
501
|
+
* },
|
|
502
|
+
* "webhook_secret": {
|
|
503
|
+
* "old_key": {...},
|
|
504
|
+
* "new_key": {...}
|
|
505
|
+
* }
|
|
506
|
+
* },
|
|
507
|
+
* "grace_period_days": 30,
|
|
508
|
+
* "grace_period_ends_at": "2026-03-07T00:00:00Z"
|
|
509
|
+
* }
|
|
510
|
+
* }
|
|
511
|
+
* ```
|
|
512
|
+
*
|
|
513
|
+
* **Authentication**: Required (api_keys.rotate.all permission)
|
|
514
|
+
* **Rate Limit**: 20 requests per hour per user
|
|
515
|
+
*
|
|
516
|
+
* **Response Codes**:
|
|
517
|
+
* - 200: Set rotated successfully
|
|
518
|
+
* - 400: Invalid request
|
|
519
|
+
* - 404: Key set not found
|
|
520
|
+
* - 401: Unauthorized
|
|
521
|
+
* - 403: Forbidden
|
|
522
|
+
* - 500: Server error
|
|
523
|
+
*/
|
|
524
|
+
post: operations["rotateApiKeySet"];
|
|
525
|
+
delete?: never;
|
|
526
|
+
options?: never;
|
|
527
|
+
head?: never;
|
|
528
|
+
patch?: never;
|
|
529
|
+
trace?: never;
|
|
530
|
+
};
|
|
531
|
+
"/v1/api-keys/validations": {
|
|
532
|
+
parameters: {
|
|
533
|
+
query?: never;
|
|
534
|
+
header?: never;
|
|
535
|
+
path?: never;
|
|
536
|
+
cookie?: never;
|
|
537
|
+
};
|
|
538
|
+
get?: never;
|
|
539
|
+
put?: never;
|
|
540
|
+
/**
|
|
541
|
+
* Validate Api Key
|
|
542
|
+
* @description **Validate API key and return metadata.**
|
|
543
|
+
*
|
|
544
|
+
* **Purpose**: High-performance validation for authentication middleware.
|
|
545
|
+
*
|
|
546
|
+
* **Flow**:
|
|
547
|
+
* 1. Check two-tier cache (L1: memory, L2: Redis)
|
|
548
|
+
* 2. If cache miss: Query database and verify hash
|
|
549
|
+
* 3. Apply filters (IP, geo, expiry, revocation)
|
|
550
|
+
* 4. Cache valid result
|
|
551
|
+
* 5. Return key metadata or error
|
|
552
|
+
*
|
|
553
|
+
* **Example Request**:
|
|
554
|
+
* ```
|
|
555
|
+
* POST /v1/api-keys/validate
|
|
556
|
+
* Headers:
|
|
557
|
+
* X-Api-Key: pk_live_abc123xyz789...
|
|
558
|
+
* X-Forwarded-For: 203.0.113.45
|
|
559
|
+
* X-Country-Code: US
|
|
560
|
+
* Origin: https://example.com
|
|
561
|
+
* ```
|
|
562
|
+
*
|
|
563
|
+
* **Example Response (Valid)**:
|
|
564
|
+
* ```json
|
|
565
|
+
* {
|
|
566
|
+
* "success": true,
|
|
567
|
+
* "data": {
|
|
568
|
+
* "valid": true,
|
|
569
|
+
* "api_key_id": 456,
|
|
570
|
+
* "api_client_id": "apicli_20260205abc123",
|
|
571
|
+
* "org_id": 123,
|
|
572
|
+
* "user_id": 789,
|
|
573
|
+
* "key_type": "payment_gateway",
|
|
574
|
+
* "environment": "live",
|
|
575
|
+
* "scopes": ["payment.read", "payment.create"],
|
|
576
|
+
* "rate_limit_per_minute": 60,
|
|
577
|
+
* "rate_limit_per_hour": 1000,
|
|
578
|
+
* "rate_limit_per_day": 10000,
|
|
579
|
+
* "metadata": {
|
|
580
|
+
* "gateway": "stripe",
|
|
581
|
+
* "account_id": "acct_abc123"
|
|
582
|
+
* }
|
|
583
|
+
* },
|
|
584
|
+
* "message": "API key validated successfully",
|
|
585
|
+
* "message_code": "api_suc_apikey_004"
|
|
586
|
+
* }
|
|
587
|
+
* ```
|
|
588
|
+
*
|
|
589
|
+
* **Example Response (Invalid)**:
|
|
590
|
+
* ```json
|
|
591
|
+
* {
|
|
592
|
+
* "success": false,
|
|
593
|
+
* "data": {
|
|
594
|
+
* "valid": false,
|
|
595
|
+
* "error_code": "EXPIRED",
|
|
596
|
+
* "error_message": "API key has expired"
|
|
597
|
+
* },
|
|
598
|
+
* "message": "API key validation failed",
|
|
599
|
+
* "message_code": "api_err_apikey_401"
|
|
600
|
+
* }
|
|
601
|
+
* ```
|
|
602
|
+
*
|
|
603
|
+
* **Performance**:
|
|
604
|
+
* - Cache hit (L1): < 1ms
|
|
605
|
+
* - Cache hit (L2): < 2ms
|
|
606
|
+
* - Cache miss + DB: < 10ms
|
|
607
|
+
*
|
|
608
|
+
* **Validation Checks**:
|
|
609
|
+
* 1. Key format (prefix, environment, length)
|
|
610
|
+
* 2. Hash verification (SHA-256 + salt)
|
|
611
|
+
* 3. Status (active, not revoked)
|
|
612
|
+
* 4. Expiration (if set)
|
|
613
|
+
* 5. IP whitelist (if configured)
|
|
614
|
+
* 6. Geo blocking (if configured)
|
|
615
|
+
* 7. CORS origin (if configured)
|
|
616
|
+
*
|
|
617
|
+
* **Error Codes**:
|
|
618
|
+
* - INVALID_FORMAT: Key format is invalid
|
|
619
|
+
* - NOT_FOUND: Key does not exist
|
|
620
|
+
* - EXPIRED: Key has expired
|
|
621
|
+
* - REVOKED: Key has been revoked
|
|
622
|
+
* - IP_BLOCKED: IP address not allowed
|
|
623
|
+
* - GEO_BLOCKED: Country blocked
|
|
624
|
+
* - ORIGIN_BLOCKED: Origin not allowed
|
|
625
|
+
* - INTERNAL_ERROR: Validation failed
|
|
626
|
+
*
|
|
627
|
+
* **Response Codes**:
|
|
628
|
+
* - 200: Validation completed (check data.valid for result)
|
|
629
|
+
* - 429: Rate limit exceeded
|
|
630
|
+
* - 500: Server error
|
|
631
|
+
*/
|
|
632
|
+
post: operations["validateApiKey"];
|
|
633
|
+
delete?: never;
|
|
634
|
+
options?: never;
|
|
635
|
+
head?: never;
|
|
636
|
+
patch?: never;
|
|
637
|
+
trace?: never;
|
|
638
|
+
};
|
|
639
|
+
"/v1/api-keys/{api_client_id}/status": {
|
|
640
|
+
parameters: {
|
|
641
|
+
query?: never;
|
|
642
|
+
header?: never;
|
|
643
|
+
path?: never;
|
|
644
|
+
cookie?: never;
|
|
645
|
+
};
|
|
646
|
+
/**
|
|
647
|
+
* Get Api Key Status
|
|
648
|
+
* @description **Get API key status without full validation.**
|
|
649
|
+
*
|
|
650
|
+
* **Purpose**: Quick status check without applying filters (IP, geo, etc.).
|
|
651
|
+
*
|
|
652
|
+
* **Flow**:
|
|
653
|
+
* 1. Query database for API key
|
|
654
|
+
* 2. Return status information
|
|
655
|
+
* 3. No validation or filtering applied
|
|
656
|
+
*
|
|
657
|
+
* **Example Request**:
|
|
658
|
+
* ```
|
|
659
|
+
* GET /v1/api-keys/apicli_20260205abc123/validation-status
|
|
660
|
+
* ```
|
|
661
|
+
*
|
|
662
|
+
* **Example Response**:
|
|
663
|
+
* ```json
|
|
664
|
+
* {
|
|
665
|
+
* "success": true,
|
|
666
|
+
* "data": {
|
|
667
|
+
* "api_client_id": "apicli_20260205abc123",
|
|
668
|
+
* "status": "active",
|
|
669
|
+
* "key_type": "payment_gateway",
|
|
670
|
+
* "environment": "live",
|
|
671
|
+
* "created_at": "2026-02-05T10:00:00Z",
|
|
672
|
+
* "expires_at": "2027-02-05T10:00:00Z",
|
|
673
|
+
* "last_used_at": "2026-02-05T14:30:00Z",
|
|
674
|
+
* "is_expired": false,
|
|
675
|
+
* "is_revoked": false,
|
|
676
|
+
* "days_until_expiry": 365
|
|
677
|
+
* },
|
|
678
|
+
* "message": "API key status retrieved",
|
|
679
|
+
* "message_code": "api_suc_apikey_005"
|
|
680
|
+
* }
|
|
681
|
+
* ```
|
|
682
|
+
*
|
|
683
|
+
* **Use Cases**:
|
|
684
|
+
* - Health checks
|
|
685
|
+
* - Monitoring dashboards
|
|
686
|
+
* - Key lifecycle tracking
|
|
687
|
+
* - Expiration alerts
|
|
688
|
+
*
|
|
689
|
+
* **Response Codes**:
|
|
690
|
+
* - 200: Success
|
|
691
|
+
* - 404: Key not found
|
|
692
|
+
* - 500: Server error
|
|
693
|
+
*/
|
|
694
|
+
get: operations["getApiKeyStatus"];
|
|
695
|
+
put?: never;
|
|
696
|
+
post?: never;
|
|
697
|
+
delete?: never;
|
|
698
|
+
options?: never;
|
|
699
|
+
head?: never;
|
|
700
|
+
patch?: never;
|
|
701
|
+
trace?: never;
|
|
702
|
+
};
|
|
703
|
+
"/v1/api-keys/{api_client_id}/stats": {
|
|
704
|
+
parameters: {
|
|
705
|
+
query?: never;
|
|
706
|
+
header?: never;
|
|
707
|
+
path?: never;
|
|
708
|
+
cookie?: never;
|
|
709
|
+
};
|
|
710
|
+
/**
|
|
711
|
+
* Get Api Key Stats
|
|
712
|
+
* @description **Get usage statistics for an API key.**
|
|
713
|
+
*
|
|
714
|
+
* **Purpose**: Analyze API key usage patterns, success rates, and performance.
|
|
715
|
+
*
|
|
716
|
+
* **Flow**:
|
|
717
|
+
* 1. Validate API key exists
|
|
718
|
+
* 2. Query usage logs for specified time period
|
|
719
|
+
* 3. Calculate aggregations (total requests, success rate, latency)
|
|
720
|
+
* 4. Group by time, geo, endpoint, status
|
|
721
|
+
*
|
|
722
|
+
* **Example Request**:
|
|
723
|
+
* ```
|
|
724
|
+
* GET /v1/api-keys/apicli_20260205abc123/stats?days=30
|
|
725
|
+
* ```
|
|
726
|
+
*
|
|
727
|
+
* **Example Response**:
|
|
728
|
+
* ```json
|
|
729
|
+
* {
|
|
730
|
+
* "success": true,
|
|
731
|
+
* "data": {
|
|
732
|
+
* "api_client_id": "apicli_20260205abc123",
|
|
733
|
+
* "period": {
|
|
734
|
+
* "start": "2026-01-06T00:00:00Z",
|
|
735
|
+
* "end": "2026-02-05T23:59:59Z",
|
|
736
|
+
* "days": 30
|
|
737
|
+
* },
|
|
738
|
+
* "summary": {
|
|
739
|
+
* "total_requests": 125000,
|
|
740
|
+
* "successful_requests": 123500,
|
|
741
|
+
* "failed_requests": 1500,
|
|
742
|
+
* "success_rate": 98.8,
|
|
743
|
+
* "avg_latency_ms": 45,
|
|
744
|
+
* "total_data_transferred_bytes": 52428800
|
|
745
|
+
* },
|
|
746
|
+
* "rate_limits": {
|
|
747
|
+
* "per_minute": {
|
|
748
|
+
* "limit": 60,
|
|
749
|
+
* "peak_usage": 58,
|
|
750
|
+
* "avg_usage": 42,
|
|
751
|
+
* "throttled_count": 3
|
|
752
|
+
* },
|
|
753
|
+
* "per_hour": {
|
|
754
|
+
* "limit": 1000,
|
|
755
|
+
* "peak_usage": 950,
|
|
756
|
+
* "avg_usage": 680
|
|
757
|
+
* },
|
|
758
|
+
* "per_day": {
|
|
759
|
+
* "limit": 10000,
|
|
760
|
+
* "peak_usage": 9500,
|
|
761
|
+
* "avg_usage": 7200
|
|
762
|
+
* }
|
|
763
|
+
* },
|
|
764
|
+
* "geo_distribution": [
|
|
765
|
+
* {"country": "US", "requests": 80000, "percentage": 64.0},
|
|
766
|
+
* {"country": "GB", "requests": 25000, "percentage": 20.0},
|
|
767
|
+
* {"country": "CA", "requests": 20000, "percentage": 16.0}
|
|
768
|
+
* ],
|
|
769
|
+
* "top_errors": [
|
|
770
|
+
* {"error_code": "RATE_LIMIT_EXCEEDED", "count": 1200, "percentage": 80.0},
|
|
771
|
+
* {"error_code": "INVALID_SCOPE", "count": 200, "percentage": 13.3},
|
|
772
|
+
* {"error_code": "EXPIRED", "count": 100, "percentage": 6.7}
|
|
773
|
+
* ],
|
|
774
|
+
* "daily_trend": [
|
|
775
|
+
* {"date": "2026-01-06", "requests": 4200, "success_rate": 99.1},
|
|
776
|
+
* {"date": "2026-01-07", "requests": 4100, "success_rate": 98.9},
|
|
777
|
+
* "..."
|
|
778
|
+
* ]
|
|
779
|
+
* },
|
|
780
|
+
* "message": "API key statistics retrieved successfully",
|
|
781
|
+
* "message_code": "api_suc_apikey_006"
|
|
782
|
+
* }
|
|
783
|
+
* ```
|
|
784
|
+
*
|
|
785
|
+
* **Use Cases**:
|
|
786
|
+
* - Monitor API key health
|
|
787
|
+
* - Detect unusual patterns
|
|
788
|
+
* - Capacity planning
|
|
789
|
+
* - Rate limit optimization
|
|
790
|
+
* - Geo-based restrictions
|
|
791
|
+
*
|
|
792
|
+
* **Performance**:
|
|
793
|
+
* - Target: < 500ms for 30-day analysis
|
|
794
|
+
* - Indexed by: api_key_id, timestamp, status
|
|
795
|
+
*
|
|
796
|
+
* **Response Codes**:
|
|
797
|
+
* - 200: Success
|
|
798
|
+
* - 403: Permission denied
|
|
799
|
+
* - 404: API key not found
|
|
800
|
+
* - 500: Server error
|
|
801
|
+
*/
|
|
802
|
+
get: operations["getApiKeyStats"];
|
|
803
|
+
put?: never;
|
|
804
|
+
post?: never;
|
|
805
|
+
delete?: never;
|
|
806
|
+
options?: never;
|
|
807
|
+
head?: never;
|
|
808
|
+
patch?: never;
|
|
809
|
+
trace?: never;
|
|
810
|
+
};
|
|
811
|
+
"/v1/api-keys/stats/admin": {
|
|
812
|
+
parameters: {
|
|
813
|
+
query?: never;
|
|
814
|
+
header?: never;
|
|
815
|
+
path?: never;
|
|
816
|
+
cookie?: never;
|
|
817
|
+
};
|
|
818
|
+
/**
|
|
819
|
+
* Get Organization Stats
|
|
820
|
+
* @description **Get organization-wide API key statistics.**
|
|
821
|
+
*
|
|
822
|
+
* **Purpose**: High-level overview of all API key usage across organization.
|
|
823
|
+
*
|
|
824
|
+
* **Example Request**:
|
|
825
|
+
* ```
|
|
826
|
+
* GET /v1/api-keys/stats/organization?days=30
|
|
827
|
+
* ```
|
|
828
|
+
*
|
|
829
|
+
* **Example Response**:
|
|
830
|
+
* ```json
|
|
831
|
+
* {
|
|
832
|
+
* "success": true,
|
|
833
|
+
* "data": {
|
|
834
|
+
* "org_id": 123,
|
|
835
|
+
* "period": {
|
|
836
|
+
* "start": "2026-01-06T00:00:00Z",
|
|
837
|
+
* "end": "2026-02-05T23:59:59Z",
|
|
838
|
+
* "days": 30
|
|
839
|
+
* },
|
|
840
|
+
* "summary": {
|
|
841
|
+
* "total_keys": 25,
|
|
842
|
+
* "active_keys": 20,
|
|
843
|
+
* "rotating_keys": 3,
|
|
844
|
+
* "revoked_keys": 2,
|
|
845
|
+
* "total_requests": 500000,
|
|
846
|
+
* "success_rate": 98.5
|
|
847
|
+
* },
|
|
848
|
+
* "by_key_type": [
|
|
849
|
+
* {"key_type": "payment_gateway", "count": 10, "requests": 300000},
|
|
850
|
+
* {"key_type": "oauth_client", "count": 8, "requests": 150000},
|
|
851
|
+
* {"key_type": "saas_provider", "count": 7, "requests": 50000}
|
|
852
|
+
* ],
|
|
853
|
+
* "by_environment": [
|
|
854
|
+
* {"environment": "live", "count": 15, "requests": 400000},
|
|
855
|
+
* {"environment": "test", "count": 10, "requests": 100000}
|
|
856
|
+
* ],
|
|
857
|
+
* "top_keys_by_usage": [
|
|
858
|
+
* {"api_client_id": "apicli_xxx", "requests": 100000, "key_type": "payment_gateway"},
|
|
859
|
+
* {"api_client_id": "apicli_yyy", "requests": 80000, "key_type": "oauth_client"}
|
|
860
|
+
* ]
|
|
861
|
+
* },
|
|
862
|
+
* "message": "Organization statistics retrieved successfully",
|
|
863
|
+
* "message_code": "api_suc_apikey_007"
|
|
864
|
+
* }
|
|
865
|
+
* ```
|
|
866
|
+
*
|
|
867
|
+
* **Response Codes**:
|
|
868
|
+
* - 200: Success
|
|
869
|
+
* - 403: Permission denied
|
|
870
|
+
* - 500: Server error
|
|
871
|
+
*/
|
|
872
|
+
get: operations["listApiKeyStats"];
|
|
873
|
+
put?: never;
|
|
874
|
+
post?: never;
|
|
875
|
+
delete?: never;
|
|
876
|
+
options?: never;
|
|
877
|
+
head?: never;
|
|
878
|
+
patch?: never;
|
|
879
|
+
trace?: never;
|
|
880
|
+
};
|
|
881
|
+
"/v1/api-keys/{api_client_id}/health": {
|
|
882
|
+
parameters: {
|
|
883
|
+
query?: never;
|
|
884
|
+
header?: never;
|
|
885
|
+
path?: never;
|
|
886
|
+
cookie?: never;
|
|
887
|
+
};
|
|
888
|
+
/**
|
|
889
|
+
* Get Api Key Health
|
|
890
|
+
* @description **Get API key health score and recommendations.**
|
|
891
|
+
*
|
|
892
|
+
* **Purpose**: Quick health check with actionable recommendations.
|
|
893
|
+
*
|
|
894
|
+
* **Example Response**:
|
|
895
|
+
* ```json
|
|
896
|
+
* {
|
|
897
|
+
* "success": true,
|
|
898
|
+
* "data": {
|
|
899
|
+
* "api_client_id": "apicli_20260205abc123",
|
|
900
|
+
* "health_score": 85,
|
|
901
|
+
* "status": "healthy",
|
|
902
|
+
* "checks": {
|
|
903
|
+
* "active": {"passed": true, "message": "Key is active"},
|
|
904
|
+
* "not_expired": {"passed": true, "message": "Key not expired"},
|
|
905
|
+
* "not_revoked": {"passed": true, "message": "Key not revoked"},
|
|
906
|
+
* "expiring_soon": {"passed": false, "message": "Key expires in 15 days"},
|
|
907
|
+
* "success_rate": {"passed": true, "value": 98.5, "threshold": 95.0}
|
|
908
|
+
* },
|
|
909
|
+
* "recommendations": [
|
|
910
|
+
* "Consider rotating this key soon (expires in 15 days)",
|
|
911
|
+
* "Success rate is healthy (98.5%)"
|
|
912
|
+
* ],
|
|
913
|
+
* "next_actions": [
|
|
914
|
+
* {
|
|
915
|
+
* "action": "rotate_key",
|
|
916
|
+
* "priority": "medium",
|
|
917
|
+
* "reason": "Key expiring soon",
|
|
918
|
+
* "deadline": "2026-02-20T00:00:00Z"
|
|
919
|
+
* }
|
|
920
|
+
* ]
|
|
921
|
+
* },
|
|
922
|
+
* "message": "API key health check completed",
|
|
923
|
+
* "message_code": "api_suc_apikey_008"
|
|
924
|
+
* }
|
|
925
|
+
* ```
|
|
926
|
+
*
|
|
927
|
+
* **Health Score Calculation**:
|
|
928
|
+
* - Active status: 20 points
|
|
929
|
+
* - Not expired: 20 points
|
|
930
|
+
* - Not revoked: 20 points
|
|
931
|
+
* - Success rate > 95%: 20 points
|
|
932
|
+
* - Not expiring soon (> 30 days): 20 points
|
|
933
|
+
*
|
|
934
|
+
* **Response Codes**:
|
|
935
|
+
* - 200: Success
|
|
936
|
+
* - 404: Key not found
|
|
937
|
+
* - 500: Server error
|
|
938
|
+
*/
|
|
939
|
+
get: operations["getApiKeyHealth"];
|
|
940
|
+
put?: never;
|
|
941
|
+
post?: never;
|
|
942
|
+
delete?: never;
|
|
943
|
+
options?: never;
|
|
944
|
+
head?: never;
|
|
945
|
+
patch?: never;
|
|
946
|
+
trace?: never;
|
|
947
|
+
};
|
|
948
|
+
"/v1/api-keys/{api_client_id}/audit-logs": {
|
|
949
|
+
parameters: {
|
|
950
|
+
query?: never;
|
|
951
|
+
header?: never;
|
|
952
|
+
path?: never;
|
|
953
|
+
cookie?: never;
|
|
954
|
+
};
|
|
955
|
+
/**
|
|
956
|
+
* Get Api Key Audit Logs
|
|
957
|
+
* @description **Get audit trail for a specific API key.**
|
|
958
|
+
*
|
|
959
|
+
* **Purpose**: Retrieve complete audit history for an API key including all lifecycle events.
|
|
960
|
+
*
|
|
961
|
+
* **Flow**:
|
|
962
|
+
* 1. Validate API key exists and belongs to organization
|
|
963
|
+
* 2. Retrieve audit logs from database with pagination
|
|
964
|
+
* 3. Return chronological audit trail with actor and metadata
|
|
965
|
+
*
|
|
966
|
+
* **Example Request**:
|
|
967
|
+
* ```
|
|
968
|
+
* GET /v1/api-keys/apicli_20260205abc123/audit-logs?skip=0&limit=50
|
|
969
|
+
* ```
|
|
970
|
+
*
|
|
971
|
+
* **Example Response**:
|
|
972
|
+
* ```json
|
|
973
|
+
* {
|
|
974
|
+
* "success": true,
|
|
975
|
+
* "data": {
|
|
976
|
+
* "api_client_id": "apicli_20260205abc123",
|
|
977
|
+
* "total_events": 15,
|
|
978
|
+
* "logs": [
|
|
979
|
+
* {
|
|
980
|
+
* "id": 1,
|
|
981
|
+
* "action": "created",
|
|
982
|
+
* "actor_type": "user",
|
|
983
|
+
* "actor_id": "usr_abc123",
|
|
984
|
+
* "ip_address": "203.0.113.45",
|
|
985
|
+
* "user_agent": "Mozilla/5.0...",
|
|
986
|
+
* "changes": {
|
|
987
|
+
* "key_type": "payment_gateway",
|
|
988
|
+
* "environment": "live"
|
|
989
|
+
* },
|
|
990
|
+
* "created_at": "2026-02-05T10:00:00Z",
|
|
991
|
+
* "log_hash": "abc123..."
|
|
992
|
+
* },
|
|
993
|
+
* {
|
|
994
|
+
* "id": 2,
|
|
995
|
+
* "action": "updated",
|
|
996
|
+
* "actor_type": "user",
|
|
997
|
+
* "actor_id": "usr_abc123",
|
|
998
|
+
* "changes": {
|
|
999
|
+
* "client_name": {
|
|
1000
|
+
* "old": "Test Key",
|
|
1001
|
+
* "new": "Production Key"
|
|
1002
|
+
* }
|
|
1003
|
+
* },
|
|
1004
|
+
* "created_at": "2026-02-05T12:00:00Z"
|
|
1005
|
+
* }
|
|
1006
|
+
* ]
|
|
1007
|
+
* },
|
|
1008
|
+
* "message": "Audit logs retrieved successfully",
|
|
1009
|
+
* "message_code": "api_suc_apikey_001"
|
|
1010
|
+
* }
|
|
1011
|
+
* ```
|
|
1012
|
+
*
|
|
1013
|
+
* **Performance**:
|
|
1014
|
+
* - Target: < 50ms for 100 logs
|
|
1015
|
+
* - Indexed by api_key_id, org_id, created_at
|
|
1016
|
+
*
|
|
1017
|
+
* **Response Codes**:
|
|
1018
|
+
* - 200: Success
|
|
1019
|
+
* - 403: Permission denied (not your organization's key)
|
|
1020
|
+
* - 404: API key not found
|
|
1021
|
+
* - 500: Server error
|
|
1022
|
+
*/
|
|
1023
|
+
get: operations["listApiKeyAuditLogs"];
|
|
1024
|
+
put?: never;
|
|
1025
|
+
post?: never;
|
|
1026
|
+
delete?: never;
|
|
1027
|
+
options?: never;
|
|
1028
|
+
head?: never;
|
|
1029
|
+
patch?: never;
|
|
1030
|
+
trace?: never;
|
|
1031
|
+
};
|
|
1032
|
+
"/v1/api-keys/audit-logs": {
|
|
1033
|
+
parameters: {
|
|
1034
|
+
query?: never;
|
|
1035
|
+
header?: never;
|
|
1036
|
+
path?: never;
|
|
1037
|
+
cookie?: never;
|
|
1038
|
+
};
|
|
1039
|
+
/**
|
|
1040
|
+
* Get Org Audit Logs
|
|
1041
|
+
* @description **Get organization-wide audit logs for all API keys.**
|
|
1042
|
+
*
|
|
1043
|
+
* **Purpose**: Retrieve consolidated audit trail across all API keys in the organization.
|
|
1044
|
+
*
|
|
1045
|
+
* **Flow**:
|
|
1046
|
+
* 1. Query audit logs for organization with optional action filter
|
|
1047
|
+
* 2. Return chronological audit trail with pagination
|
|
1048
|
+
* 3. Include API key identifiers for each event
|
|
1049
|
+
*
|
|
1050
|
+
* **Example Request**:
|
|
1051
|
+
* ```
|
|
1052
|
+
* GET /v1/api-keys/audit-logs?action=revoked&skip=0&limit=50
|
|
1053
|
+
* ```
|
|
1054
|
+
*
|
|
1055
|
+
* **Example Response**:
|
|
1056
|
+
* ```json
|
|
1057
|
+
* {
|
|
1058
|
+
* "success": true,
|
|
1059
|
+
* "data": {
|
|
1060
|
+
* "org_id": 123,
|
|
1061
|
+
* "total_events": 250,
|
|
1062
|
+
* "filter": {
|
|
1063
|
+
* "action": "revoked"
|
|
1064
|
+
* },
|
|
1065
|
+
* "logs": [
|
|
1066
|
+
* {
|
|
1067
|
+
* "id": 1,
|
|
1068
|
+
* "api_key_id": 456,
|
|
1069
|
+
* "api_client_id": "apicli_20260205abc123",
|
|
1070
|
+
* "action": "revoked",
|
|
1071
|
+
* "actor_type": "user",
|
|
1072
|
+
* "actor_id": "usr_abc123",
|
|
1073
|
+
* "reason": "Security compromise - rotating keys",
|
|
1074
|
+
* "created_at": "2026-02-05T14:30:00Z"
|
|
1075
|
+
* }
|
|
1076
|
+
* ]
|
|
1077
|
+
* },
|
|
1078
|
+
* "message": "Organization audit logs retrieved successfully",
|
|
1079
|
+
* "message_code": "api_suc_apikey_002"
|
|
1080
|
+
* }
|
|
1081
|
+
* ```
|
|
1082
|
+
*
|
|
1083
|
+
* **Use Cases**:
|
|
1084
|
+
* - Compliance reporting
|
|
1085
|
+
* - Security incident investigation
|
|
1086
|
+
* - Activity monitoring
|
|
1087
|
+
* - Anomaly detection
|
|
1088
|
+
*
|
|
1089
|
+
* **Performance**:
|
|
1090
|
+
* - Target: < 100ms for 100 logs
|
|
1091
|
+
* - Indexed by org_id, action, created_at
|
|
1092
|
+
*
|
|
1093
|
+
* **Response Codes**:
|
|
1094
|
+
* - 200: Success
|
|
1095
|
+
* - 403: Permission denied (requires api_keys.audit.all)
|
|
1096
|
+
* - 500: Server error
|
|
1097
|
+
*/
|
|
1098
|
+
get: operations["listOrgAuditLogs"];
|
|
1099
|
+
put?: never;
|
|
1100
|
+
post?: never;
|
|
1101
|
+
delete?: never;
|
|
1102
|
+
options?: never;
|
|
1103
|
+
head?: never;
|
|
1104
|
+
patch?: never;
|
|
1105
|
+
trace?: never;
|
|
1106
|
+
};
|
|
1107
|
+
"/v1/api-keys/audit-logs/{log_id}/integrity-checks": {
|
|
1108
|
+
parameters: {
|
|
1109
|
+
query?: never;
|
|
1110
|
+
header?: never;
|
|
1111
|
+
path?: never;
|
|
1112
|
+
cookie?: never;
|
|
1113
|
+
};
|
|
1114
|
+
get?: never;
|
|
1115
|
+
put?: never;
|
|
1116
|
+
/**
|
|
1117
|
+
* Check Audit Log Integrity
|
|
1118
|
+
* @description **Verify audit log integrity (tamper detection).**
|
|
1119
|
+
*
|
|
1120
|
+
* **Purpose**: Cryptographically verify that an audit log entry has not been tampered with.
|
|
1121
|
+
*
|
|
1122
|
+
* **Flow**:
|
|
1123
|
+
* 1. Retrieve audit log from database
|
|
1124
|
+
* 2. Recompute SHA-256 hash from log data
|
|
1125
|
+
* 3. Compare with stored log_hash
|
|
1126
|
+
* 4. Return verification result
|
|
1127
|
+
*
|
|
1128
|
+
* **Example Request**:
|
|
1129
|
+
* ```
|
|
1130
|
+
* POST /v1/api-keys/audit-logs/123/verify
|
|
1131
|
+
* ```
|
|
1132
|
+
*
|
|
1133
|
+
* **Example Response**:
|
|
1134
|
+
* ```json
|
|
1135
|
+
* {
|
|
1136
|
+
* "success": true,
|
|
1137
|
+
* "data": {
|
|
1138
|
+
* "log_id": 123,
|
|
1139
|
+
* "verified": true,
|
|
1140
|
+
* "message": "Log integrity verified - no tampering detected",
|
|
1141
|
+
* "log_hash": "abc123...",
|
|
1142
|
+
* "verification_timestamp": "2026-02-05T15:00:00Z"
|
|
1143
|
+
* },
|
|
1144
|
+
* "message": "Audit log verification completed",
|
|
1145
|
+
* "message_code": "api_suc_apikey_003"
|
|
1146
|
+
* }
|
|
1147
|
+
* ```
|
|
1148
|
+
*
|
|
1149
|
+
* **Security**:
|
|
1150
|
+
* - Uses SHA-256 hash of log data
|
|
1151
|
+
* - Includes: api_key_id, action, actor_type, actor_id, timestamp, changes
|
|
1152
|
+
* - Tamper-evident: Any modification invalidates hash
|
|
1153
|
+
*
|
|
1154
|
+
* **Use Cases**:
|
|
1155
|
+
* - Compliance audits
|
|
1156
|
+
* - Forensic investigations
|
|
1157
|
+
* - Security certifications
|
|
1158
|
+
* - Legal evidence
|
|
1159
|
+
*
|
|
1160
|
+
* **Response Codes**:
|
|
1161
|
+
* - 200: Success (verified=true/false in response)
|
|
1162
|
+
* - 404: Log not found
|
|
1163
|
+
* - 403: Permission denied
|
|
1164
|
+
* - 500: Server error
|
|
1165
|
+
*/
|
|
1166
|
+
post: operations["checkAuditLogIntegrity"];
|
|
1167
|
+
delete?: never;
|
|
1168
|
+
options?: never;
|
|
1169
|
+
head?: never;
|
|
1170
|
+
patch?: never;
|
|
1171
|
+
trace?: never;
|
|
1172
|
+
};
|
|
1173
|
+
}
|
|
1174
|
+
export type webhooks = Record<string, never>;
|
|
1175
|
+
export interface components {
|
|
1176
|
+
schemas: {
|
|
1177
|
+
/**
|
|
1178
|
+
* KeyType
|
|
1179
|
+
* @description API key types
|
|
1180
|
+
* @enum {string}
|
|
1181
|
+
*/
|
|
1182
|
+
KeyType: "public" | "secret" | "restricted" | "webhook" | "mobile";
|
|
1183
|
+
/**
|
|
1184
|
+
* APIKeyRevokeRequest
|
|
1185
|
+
* @description Request schema for revoking an API key.
|
|
1186
|
+
*
|
|
1187
|
+
* Immediate revocation (no grace period).
|
|
1188
|
+
*/
|
|
1189
|
+
APIKeyRevokeRequest: {
|
|
1190
|
+
/**
|
|
1191
|
+
* Reason
|
|
1192
|
+
* @description Reason for revocation (required for audit)
|
|
1193
|
+
*/
|
|
1194
|
+
reason: string;
|
|
1195
|
+
};
|
|
1196
|
+
/**
|
|
1197
|
+
* APIKeyRotateRequest
|
|
1198
|
+
* @description Request schema for rotating an API key.
|
|
1199
|
+
*
|
|
1200
|
+
* Creates new key, marks old as rotating, provides grace period.
|
|
1201
|
+
*/
|
|
1202
|
+
APIKeyRotateRequest: {
|
|
1203
|
+
/**
|
|
1204
|
+
* Grace Period Days
|
|
1205
|
+
* @description Days to keep old key valid (default: 30)
|
|
1206
|
+
* @default 30
|
|
1207
|
+
*/
|
|
1208
|
+
grace_period_days: number | null;
|
|
1209
|
+
/**
|
|
1210
|
+
* Reason
|
|
1211
|
+
* @description Reason for rotation (audit trail)
|
|
1212
|
+
*/
|
|
1213
|
+
reason?: string | null;
|
|
1214
|
+
};
|
|
1215
|
+
/** ValidationError */
|
|
1216
|
+
ValidationError: {
|
|
1217
|
+
/** Location */
|
|
1218
|
+
loc: (string | number)[];
|
|
1219
|
+
/** Message */
|
|
1220
|
+
msg: string;
|
|
1221
|
+
/** Error Type */
|
|
1222
|
+
type: string;
|
|
1223
|
+
};
|
|
1224
|
+
/**
|
|
1225
|
+
* APIKeyUpdateRequest
|
|
1226
|
+
* @description Request schema for updating API key metadata.
|
|
1227
|
+
*
|
|
1228
|
+
* Note: Cannot update key_hash, key_type, or environment.
|
|
1229
|
+
* Use rotation for key changes.
|
|
1230
|
+
*/
|
|
1231
|
+
APIKeyUpdateRequest: {
|
|
1232
|
+
/**
|
|
1233
|
+
* Client Name
|
|
1234
|
+
* @description Update client name
|
|
1235
|
+
*/
|
|
1236
|
+
client_name?: string | null;
|
|
1237
|
+
/**
|
|
1238
|
+
* Scopes
|
|
1239
|
+
* @description Update scopes
|
|
1240
|
+
*/
|
|
1241
|
+
scopes?: string[] | null;
|
|
1242
|
+
/**
|
|
1243
|
+
* Allowed Ips
|
|
1244
|
+
* @description Update allowed IPs
|
|
1245
|
+
*/
|
|
1246
|
+
allowed_ips?: string[] | null;
|
|
1247
|
+
/** Allowed Countries */
|
|
1248
|
+
allowed_countries?: string[] | null;
|
|
1249
|
+
/** Blocked Countries */
|
|
1250
|
+
blocked_countries?: string[] | null;
|
|
1251
|
+
/** Allowed Origins */
|
|
1252
|
+
allowed_origins?: string[] | null;
|
|
1253
|
+
/** Rate Limit Per Minute */
|
|
1254
|
+
rate_limit_per_minute?: number | null;
|
|
1255
|
+
/** Rate Limit Per Hour */
|
|
1256
|
+
rate_limit_per_hour?: number | null;
|
|
1257
|
+
/** Rate Limit Per Day */
|
|
1258
|
+
rate_limit_per_day?: number | null;
|
|
1259
|
+
/** Expires At */
|
|
1260
|
+
expires_at?: string | null;
|
|
1261
|
+
/** Webhook Url */
|
|
1262
|
+
webhook_url?: string | null;
|
|
1263
|
+
/** Webhook Secret */
|
|
1264
|
+
webhook_secret?: string | null;
|
|
1265
|
+
/** Webhook Events */
|
|
1266
|
+
webhook_events?: string[] | null;
|
|
1267
|
+
/** Client Metadata */
|
|
1268
|
+
client_metadata?: {
|
|
1269
|
+
[key: string]: unknown;
|
|
1270
|
+
} | null;
|
|
1271
|
+
};
|
|
1272
|
+
/**
|
|
1273
|
+
* APIKeyBatchCreateRequest
|
|
1274
|
+
* @description Request schema for creating multiple API keys from a context template.
|
|
1275
|
+
*
|
|
1276
|
+
* Used for products requiring multiple key types (e.g., payment gateway).
|
|
1277
|
+
*/
|
|
1278
|
+
APIKeyBatchCreateRequest: {
|
|
1279
|
+
/**
|
|
1280
|
+
* Product Type
|
|
1281
|
+
* @description Product type: payment_gateway, oauth_app, saas_provider
|
|
1282
|
+
*/
|
|
1283
|
+
product_type: string;
|
|
1284
|
+
/** @description Environment for all keys */
|
|
1285
|
+
environment: components["schemas"]["Environment"];
|
|
1286
|
+
/**
|
|
1287
|
+
* Client Name
|
|
1288
|
+
* @description Base name for key set
|
|
1289
|
+
*/
|
|
1290
|
+
client_name: string;
|
|
1291
|
+
/** Scopes */
|
|
1292
|
+
scopes?: string[] | null;
|
|
1293
|
+
/** Allowed Ips */
|
|
1294
|
+
allowed_ips?: string[] | null;
|
|
1295
|
+
/** Allowed Countries */
|
|
1296
|
+
allowed_countries?: string[] | null;
|
|
1297
|
+
/**
|
|
1298
|
+
* Rate Limit Per Minute
|
|
1299
|
+
* @default 60
|
|
1300
|
+
*/
|
|
1301
|
+
rate_limit_per_minute: number | null;
|
|
1302
|
+
/** Expires At */
|
|
1303
|
+
expires_at?: string | null;
|
|
1304
|
+
/** Client Metadata */
|
|
1305
|
+
client_metadata?: {
|
|
1306
|
+
[key: string]: unknown;
|
|
1307
|
+
} | null;
|
|
1308
|
+
};
|
|
1309
|
+
/**
|
|
1310
|
+
* Environment
|
|
1311
|
+
* @description API key environments
|
|
1312
|
+
* @enum {string}
|
|
1313
|
+
*/
|
|
1314
|
+
Environment: "development" | "test" | "live";
|
|
1315
|
+
/** HTTPValidationError */
|
|
1316
|
+
HTTPValidationError: {
|
|
1317
|
+
/** Detail */
|
|
1318
|
+
detail?: components["schemas"]["ValidationError"][];
|
|
1319
|
+
};
|
|
1320
|
+
/**
|
|
1321
|
+
* APIKeyCreateRequest
|
|
1322
|
+
* @description Request schema for creating a new API key.
|
|
1323
|
+
*
|
|
1324
|
+
* Example:
|
|
1325
|
+
* {
|
|
1326
|
+
* "client_name": "Production Frontend",
|
|
1327
|
+
* "key_type": "public",
|
|
1328
|
+
* "environment": "live",
|
|
1329
|
+
* "scopes": ["orders:read", "products:read"],
|
|
1330
|
+
* "rate_limit_per_minute": 100,
|
|
1331
|
+
* "allowed_ips": ["203.0.113.0/24"],
|
|
1332
|
+
* "expires_at": "2027-12-31T23:59:59Z"
|
|
1333
|
+
* }
|
|
1334
|
+
*/
|
|
1335
|
+
APIKeyCreateRequest: {
|
|
1336
|
+
/**
|
|
1337
|
+
* Client Name
|
|
1338
|
+
* @description Human-readable name for this API key
|
|
1339
|
+
*/
|
|
1340
|
+
client_name: string;
|
|
1341
|
+
/** @description Key type: public, secret, restricted, webhook */
|
|
1342
|
+
key_type: components["schemas"]["KeyType"];
|
|
1343
|
+
/** @description Environment: development, test, live */
|
|
1344
|
+
environment: components["schemas"]["Environment"];
|
|
1345
|
+
/**
|
|
1346
|
+
* Context
|
|
1347
|
+
* @description Context within key set (e.g., public_key, webhook_secret)
|
|
1348
|
+
*/
|
|
1349
|
+
context?: string | null;
|
|
1350
|
+
/**
|
|
1351
|
+
* Key Set Id
|
|
1352
|
+
* @description Groups related keys (e.g., payment gateway keys)
|
|
1353
|
+
*/
|
|
1354
|
+
key_set_id?: string | null;
|
|
1355
|
+
/**
|
|
1356
|
+
* Tenant Domain Id
|
|
1357
|
+
* @description Domain-specific key (optional)
|
|
1358
|
+
*/
|
|
1359
|
+
tenant_domain_id?: number | null;
|
|
1360
|
+
/**
|
|
1361
|
+
* Scopes
|
|
1362
|
+
* @description OAuth 2.0 scopes: ['orders:read', 'payments:write']
|
|
1363
|
+
*/
|
|
1364
|
+
scopes?: string[] | null;
|
|
1365
|
+
/**
|
|
1366
|
+
* Allowed Ips
|
|
1367
|
+
* @description Allowed IP addresses/CIDRs: ['203.0.113.0/24']
|
|
1368
|
+
*/
|
|
1369
|
+
allowed_ips?: string[] | null;
|
|
1370
|
+
/**
|
|
1371
|
+
* Allowed Countries
|
|
1372
|
+
* @description Allowed country codes: ['US', 'CA', 'GB']
|
|
1373
|
+
*/
|
|
1374
|
+
allowed_countries?: string[] | null;
|
|
1375
|
+
/**
|
|
1376
|
+
* Blocked Countries
|
|
1377
|
+
* @description Blocked country codes: ['KP', 'IR']
|
|
1378
|
+
*/
|
|
1379
|
+
blocked_countries?: string[] | null;
|
|
1380
|
+
/**
|
|
1381
|
+
* Allowed Origins
|
|
1382
|
+
* @description CORS origins: ['https://example.com']
|
|
1383
|
+
*/
|
|
1384
|
+
allowed_origins?: string[] | null;
|
|
1385
|
+
/**
|
|
1386
|
+
* Rate Limit Per Minute
|
|
1387
|
+
* @description Requests per minute (default: 60)
|
|
1388
|
+
* @default 60
|
|
1389
|
+
*/
|
|
1390
|
+
rate_limit_per_minute: number | null;
|
|
1391
|
+
/**
|
|
1392
|
+
* Rate Limit Per Hour
|
|
1393
|
+
* @description Requests per hour (default: 3600)
|
|
1394
|
+
* @default 3600
|
|
1395
|
+
*/
|
|
1396
|
+
rate_limit_per_hour: number | null;
|
|
1397
|
+
/**
|
|
1398
|
+
* Rate Limit Per Day
|
|
1399
|
+
* @description Requests per day (default: 100000)
|
|
1400
|
+
* @default 100000
|
|
1401
|
+
*/
|
|
1402
|
+
rate_limit_per_day: number | null;
|
|
1403
|
+
/**
|
|
1404
|
+
* Expires At
|
|
1405
|
+
* @description Optional expiration timestamp (NULL = never expires)
|
|
1406
|
+
*/
|
|
1407
|
+
expires_at?: string | null;
|
|
1408
|
+
/**
|
|
1409
|
+
* Webhook Url
|
|
1410
|
+
* @description Webhook endpoint URL
|
|
1411
|
+
*/
|
|
1412
|
+
webhook_url?: string | null;
|
|
1413
|
+
/**
|
|
1414
|
+
* Webhook Secret
|
|
1415
|
+
* @description Webhook signature secret
|
|
1416
|
+
*/
|
|
1417
|
+
webhook_secret?: string | null;
|
|
1418
|
+
/**
|
|
1419
|
+
* Webhook Events
|
|
1420
|
+
* @description Events to send: ['order.created', 'payment.succeeded']
|
|
1421
|
+
*/
|
|
1422
|
+
webhook_events?: string[] | null;
|
|
1423
|
+
/**
|
|
1424
|
+
* Client Metadata
|
|
1425
|
+
* @description Custom metadata
|
|
1426
|
+
*/
|
|
1427
|
+
client_metadata?: {
|
|
1428
|
+
[key: string]: unknown;
|
|
1429
|
+
} | null;
|
|
1430
|
+
};
|
|
1431
|
+
};
|
|
1432
|
+
responses: never;
|
|
1433
|
+
parameters: never;
|
|
1434
|
+
requestBodies: never;
|
|
1435
|
+
headers: never;
|
|
1436
|
+
pathItems: never;
|
|
1437
|
+
}
|
|
1438
|
+
export type $defs = Record<string, never>;
|
|
1439
|
+
export interface operations {
|
|
1440
|
+
listApiKeys: {
|
|
1441
|
+
parameters: {
|
|
1442
|
+
query?: {
|
|
1443
|
+
/** @description Filter by environment */
|
|
1444
|
+
environment?: string;
|
|
1445
|
+
/** @description Filter by key type */
|
|
1446
|
+
key_type?: string;
|
|
1447
|
+
/** @description Filter by status */
|
|
1448
|
+
status?: string;
|
|
1449
|
+
/** @description Page number (1-based) */
|
|
1450
|
+
page?: number;
|
|
1451
|
+
/** @description Items per page (1–100, default 50) */
|
|
1452
|
+
limit?: number;
|
|
1453
|
+
};
|
|
1454
|
+
header?: {
|
|
1455
|
+
authorization?: string | null;
|
|
1456
|
+
};
|
|
1457
|
+
path?: never;
|
|
1458
|
+
cookie?: never;
|
|
1459
|
+
};
|
|
1460
|
+
requestBody?: never;
|
|
1461
|
+
responses: {
|
|
1462
|
+
/** @description Successful Response */
|
|
1463
|
+
200: {
|
|
1464
|
+
headers: {
|
|
1465
|
+
[name: string]: unknown;
|
|
1466
|
+
};
|
|
1467
|
+
content: {
|
|
1468
|
+
"application/json": {
|
|
1469
|
+
[key: string]: unknown;
|
|
1470
|
+
};
|
|
1471
|
+
};
|
|
1472
|
+
};
|
|
1473
|
+
/** @description Validation Error */
|
|
1474
|
+
422: {
|
|
1475
|
+
headers: {
|
|
1476
|
+
[name: string]: unknown;
|
|
1477
|
+
};
|
|
1478
|
+
content: {
|
|
1479
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
1480
|
+
};
|
|
1481
|
+
};
|
|
1482
|
+
};
|
|
1483
|
+
};
|
|
1484
|
+
createApiKey: {
|
|
1485
|
+
parameters: {
|
|
1486
|
+
query?: never;
|
|
1487
|
+
header?: {
|
|
1488
|
+
authorization?: string | null;
|
|
1489
|
+
};
|
|
1490
|
+
path?: never;
|
|
1491
|
+
cookie?: never;
|
|
1492
|
+
};
|
|
1493
|
+
requestBody: {
|
|
1494
|
+
content: {
|
|
1495
|
+
"application/json": components["schemas"]["APIKeyCreateRequest"];
|
|
1496
|
+
};
|
|
1497
|
+
};
|
|
1498
|
+
responses: {
|
|
1499
|
+
/** @description Successful Response */
|
|
1500
|
+
201: {
|
|
1501
|
+
headers: {
|
|
1502
|
+
[name: string]: unknown;
|
|
1503
|
+
};
|
|
1504
|
+
content: {
|
|
1505
|
+
"application/json": {
|
|
1506
|
+
[key: string]: unknown;
|
|
1507
|
+
};
|
|
1508
|
+
};
|
|
1509
|
+
};
|
|
1510
|
+
/** @description Validation Error */
|
|
1511
|
+
422: {
|
|
1512
|
+
headers: {
|
|
1513
|
+
[name: string]: unknown;
|
|
1514
|
+
};
|
|
1515
|
+
content: {
|
|
1516
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
1517
|
+
};
|
|
1518
|
+
};
|
|
1519
|
+
};
|
|
1520
|
+
};
|
|
1521
|
+
createApiKeyBatch: {
|
|
1522
|
+
parameters: {
|
|
1523
|
+
query?: never;
|
|
1524
|
+
header?: {
|
|
1525
|
+
authorization?: string | null;
|
|
1526
|
+
};
|
|
1527
|
+
path?: never;
|
|
1528
|
+
cookie?: never;
|
|
1529
|
+
};
|
|
1530
|
+
requestBody: {
|
|
1531
|
+
content: {
|
|
1532
|
+
"application/json": components["schemas"]["APIKeyBatchCreateRequest"];
|
|
1533
|
+
};
|
|
1534
|
+
};
|
|
1535
|
+
responses: {
|
|
1536
|
+
/** @description Successful Response */
|
|
1537
|
+
201: {
|
|
1538
|
+
headers: {
|
|
1539
|
+
[name: string]: unknown;
|
|
1540
|
+
};
|
|
1541
|
+
content: {
|
|
1542
|
+
"application/json": {
|
|
1543
|
+
[key: string]: unknown;
|
|
1544
|
+
};
|
|
1545
|
+
};
|
|
1546
|
+
};
|
|
1547
|
+
/** @description Validation Error */
|
|
1548
|
+
422: {
|
|
1549
|
+
headers: {
|
|
1550
|
+
[name: string]: unknown;
|
|
1551
|
+
};
|
|
1552
|
+
content: {
|
|
1553
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
1554
|
+
};
|
|
1555
|
+
};
|
|
1556
|
+
};
|
|
1557
|
+
};
|
|
1558
|
+
getApiKey: {
|
|
1559
|
+
parameters: {
|
|
1560
|
+
query?: never;
|
|
1561
|
+
header?: {
|
|
1562
|
+
authorization?: string | null;
|
|
1563
|
+
};
|
|
1564
|
+
path: {
|
|
1565
|
+
api_client_id: string;
|
|
1566
|
+
};
|
|
1567
|
+
cookie?: never;
|
|
1568
|
+
};
|
|
1569
|
+
requestBody?: never;
|
|
1570
|
+
responses: {
|
|
1571
|
+
/** @description Successful Response */
|
|
1572
|
+
200: {
|
|
1573
|
+
headers: {
|
|
1574
|
+
[name: string]: unknown;
|
|
1575
|
+
};
|
|
1576
|
+
content: {
|
|
1577
|
+
"application/json": {
|
|
1578
|
+
[key: string]: unknown;
|
|
1579
|
+
};
|
|
1580
|
+
};
|
|
1581
|
+
};
|
|
1582
|
+
/** @description Validation Error */
|
|
1583
|
+
422: {
|
|
1584
|
+
headers: {
|
|
1585
|
+
[name: string]: unknown;
|
|
1586
|
+
};
|
|
1587
|
+
content: {
|
|
1588
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
1589
|
+
};
|
|
1590
|
+
};
|
|
1591
|
+
};
|
|
1592
|
+
};
|
|
1593
|
+
updateApiKey: {
|
|
1594
|
+
parameters: {
|
|
1595
|
+
query?: never;
|
|
1596
|
+
header?: {
|
|
1597
|
+
authorization?: string | null;
|
|
1598
|
+
};
|
|
1599
|
+
path: {
|
|
1600
|
+
api_client_id: string;
|
|
1601
|
+
};
|
|
1602
|
+
cookie?: never;
|
|
1603
|
+
};
|
|
1604
|
+
requestBody: {
|
|
1605
|
+
content: {
|
|
1606
|
+
"application/json": components["schemas"]["APIKeyUpdateRequest"];
|
|
1607
|
+
};
|
|
1608
|
+
};
|
|
1609
|
+
responses: {
|
|
1610
|
+
/** @description Successful Response */
|
|
1611
|
+
200: {
|
|
1612
|
+
headers: {
|
|
1613
|
+
[name: string]: unknown;
|
|
1614
|
+
};
|
|
1615
|
+
content: {
|
|
1616
|
+
"application/json": {
|
|
1617
|
+
[key: string]: unknown;
|
|
1618
|
+
};
|
|
1619
|
+
};
|
|
1620
|
+
};
|
|
1621
|
+
/** @description Validation Error */
|
|
1622
|
+
422: {
|
|
1623
|
+
headers: {
|
|
1624
|
+
[name: string]: unknown;
|
|
1625
|
+
};
|
|
1626
|
+
content: {
|
|
1627
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
1628
|
+
};
|
|
1629
|
+
};
|
|
1630
|
+
};
|
|
1631
|
+
};
|
|
1632
|
+
revokeApiKey: {
|
|
1633
|
+
parameters: {
|
|
1634
|
+
query?: never;
|
|
1635
|
+
header?: {
|
|
1636
|
+
authorization?: string | null;
|
|
1637
|
+
};
|
|
1638
|
+
path: {
|
|
1639
|
+
api_client_id: string;
|
|
1640
|
+
};
|
|
1641
|
+
cookie?: never;
|
|
1642
|
+
};
|
|
1643
|
+
requestBody: {
|
|
1644
|
+
content: {
|
|
1645
|
+
"application/json": components["schemas"]["APIKeyRevokeRequest"];
|
|
1646
|
+
};
|
|
1647
|
+
};
|
|
1648
|
+
responses: {
|
|
1649
|
+
/** @description Successful Response */
|
|
1650
|
+
200: {
|
|
1651
|
+
headers: {
|
|
1652
|
+
[name: string]: unknown;
|
|
1653
|
+
};
|
|
1654
|
+
content: {
|
|
1655
|
+
"application/json": {
|
|
1656
|
+
[key: string]: unknown;
|
|
1657
|
+
};
|
|
1658
|
+
};
|
|
1659
|
+
};
|
|
1660
|
+
/** @description Validation Error */
|
|
1661
|
+
422: {
|
|
1662
|
+
headers: {
|
|
1663
|
+
[name: string]: unknown;
|
|
1664
|
+
};
|
|
1665
|
+
content: {
|
|
1666
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
1667
|
+
};
|
|
1668
|
+
};
|
|
1669
|
+
};
|
|
1670
|
+
};
|
|
1671
|
+
rotateApiKey: {
|
|
1672
|
+
parameters: {
|
|
1673
|
+
query?: never;
|
|
1674
|
+
header?: {
|
|
1675
|
+
authorization?: string | null;
|
|
1676
|
+
};
|
|
1677
|
+
path: {
|
|
1678
|
+
api_client_id: string;
|
|
1679
|
+
};
|
|
1680
|
+
cookie?: never;
|
|
1681
|
+
};
|
|
1682
|
+
requestBody: {
|
|
1683
|
+
content: {
|
|
1684
|
+
"application/json": components["schemas"]["APIKeyRotateRequest"];
|
|
1685
|
+
};
|
|
1686
|
+
};
|
|
1687
|
+
responses: {
|
|
1688
|
+
/** @description Successful Response */
|
|
1689
|
+
200: {
|
|
1690
|
+
headers: {
|
|
1691
|
+
[name: string]: unknown;
|
|
1692
|
+
};
|
|
1693
|
+
content: {
|
|
1694
|
+
"application/json": {
|
|
1695
|
+
[key: string]: unknown;
|
|
1696
|
+
};
|
|
1697
|
+
};
|
|
1698
|
+
};
|
|
1699
|
+
/** @description Validation Error */
|
|
1700
|
+
422: {
|
|
1701
|
+
headers: {
|
|
1702
|
+
[name: string]: unknown;
|
|
1703
|
+
};
|
|
1704
|
+
content: {
|
|
1705
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
1706
|
+
};
|
|
1707
|
+
};
|
|
1708
|
+
};
|
|
1709
|
+
};
|
|
1710
|
+
rotateApiKeySet: {
|
|
1711
|
+
parameters: {
|
|
1712
|
+
query?: never;
|
|
1713
|
+
header?: {
|
|
1714
|
+
authorization?: string | null;
|
|
1715
|
+
};
|
|
1716
|
+
path: {
|
|
1717
|
+
key_set_id: string;
|
|
1718
|
+
};
|
|
1719
|
+
cookie?: never;
|
|
1720
|
+
};
|
|
1721
|
+
requestBody: {
|
|
1722
|
+
content: {
|
|
1723
|
+
"application/json": components["schemas"]["APIKeyRotateRequest"];
|
|
1724
|
+
};
|
|
1725
|
+
};
|
|
1726
|
+
responses: {
|
|
1727
|
+
/** @description Successful Response */
|
|
1728
|
+
200: {
|
|
1729
|
+
headers: {
|
|
1730
|
+
[name: string]: unknown;
|
|
1731
|
+
};
|
|
1732
|
+
content: {
|
|
1733
|
+
"application/json": {
|
|
1734
|
+
[key: string]: unknown;
|
|
1735
|
+
};
|
|
1736
|
+
};
|
|
1737
|
+
};
|
|
1738
|
+
/** @description Validation Error */
|
|
1739
|
+
422: {
|
|
1740
|
+
headers: {
|
|
1741
|
+
[name: string]: unknown;
|
|
1742
|
+
};
|
|
1743
|
+
content: {
|
|
1744
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
1745
|
+
};
|
|
1746
|
+
};
|
|
1747
|
+
};
|
|
1748
|
+
};
|
|
1749
|
+
validateApiKey: {
|
|
1750
|
+
parameters: {
|
|
1751
|
+
query?: never;
|
|
1752
|
+
header: {
|
|
1753
|
+
/** @description API key to validate */
|
|
1754
|
+
"X-Api-Key": string;
|
|
1755
|
+
/** @description Client IP address */
|
|
1756
|
+
"x-forwarded-for"?: string | null;
|
|
1757
|
+
/** @description Client country code */
|
|
1758
|
+
"x-country-code"?: string | null;
|
|
1759
|
+
/** @description Request origin (for CORS) */
|
|
1760
|
+
origin?: string | null;
|
|
1761
|
+
};
|
|
1762
|
+
path?: never;
|
|
1763
|
+
cookie?: never;
|
|
1764
|
+
};
|
|
1765
|
+
requestBody?: never;
|
|
1766
|
+
responses: {
|
|
1767
|
+
/** @description Successful Response */
|
|
1768
|
+
200: {
|
|
1769
|
+
headers: {
|
|
1770
|
+
[name: string]: unknown;
|
|
1771
|
+
};
|
|
1772
|
+
content: {
|
|
1773
|
+
"application/json": {
|
|
1774
|
+
[key: string]: unknown;
|
|
1775
|
+
};
|
|
1776
|
+
};
|
|
1777
|
+
};
|
|
1778
|
+
/** @description Validation Error */
|
|
1779
|
+
422: {
|
|
1780
|
+
headers: {
|
|
1781
|
+
[name: string]: unknown;
|
|
1782
|
+
};
|
|
1783
|
+
content: {
|
|
1784
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
1785
|
+
};
|
|
1786
|
+
};
|
|
1787
|
+
};
|
|
1788
|
+
};
|
|
1789
|
+
getApiKeyStatus: {
|
|
1790
|
+
parameters: {
|
|
1791
|
+
query?: never;
|
|
1792
|
+
header?: never;
|
|
1793
|
+
path: {
|
|
1794
|
+
api_client_id: string;
|
|
1795
|
+
};
|
|
1796
|
+
cookie?: never;
|
|
1797
|
+
};
|
|
1798
|
+
requestBody?: never;
|
|
1799
|
+
responses: {
|
|
1800
|
+
/** @description Successful Response */
|
|
1801
|
+
200: {
|
|
1802
|
+
headers: {
|
|
1803
|
+
[name: string]: unknown;
|
|
1804
|
+
};
|
|
1805
|
+
content: {
|
|
1806
|
+
"application/json": {
|
|
1807
|
+
[key: string]: unknown;
|
|
1808
|
+
};
|
|
1809
|
+
};
|
|
1810
|
+
};
|
|
1811
|
+
/** @description Validation Error */
|
|
1812
|
+
422: {
|
|
1813
|
+
headers: {
|
|
1814
|
+
[name: string]: unknown;
|
|
1815
|
+
};
|
|
1816
|
+
content: {
|
|
1817
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
1818
|
+
};
|
|
1819
|
+
};
|
|
1820
|
+
};
|
|
1821
|
+
};
|
|
1822
|
+
getApiKeyStats: {
|
|
1823
|
+
parameters: {
|
|
1824
|
+
query?: {
|
|
1825
|
+
/** @description Number of days to analyze (1-90) */
|
|
1826
|
+
days?: number;
|
|
1827
|
+
};
|
|
1828
|
+
header?: {
|
|
1829
|
+
authorization?: string | null;
|
|
1830
|
+
};
|
|
1831
|
+
path: {
|
|
1832
|
+
/** @description External API client ID */
|
|
1833
|
+
api_client_id: string;
|
|
1834
|
+
};
|
|
1835
|
+
cookie?: never;
|
|
1836
|
+
};
|
|
1837
|
+
requestBody?: never;
|
|
1838
|
+
responses: {
|
|
1839
|
+
/** @description Successful Response */
|
|
1840
|
+
200: {
|
|
1841
|
+
headers: {
|
|
1842
|
+
[name: string]: unknown;
|
|
1843
|
+
};
|
|
1844
|
+
content: {
|
|
1845
|
+
"application/json": {
|
|
1846
|
+
[key: string]: unknown;
|
|
1847
|
+
};
|
|
1848
|
+
};
|
|
1849
|
+
};
|
|
1850
|
+
/** @description Validation Error */
|
|
1851
|
+
422: {
|
|
1852
|
+
headers: {
|
|
1853
|
+
[name: string]: unknown;
|
|
1854
|
+
};
|
|
1855
|
+
content: {
|
|
1856
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
1857
|
+
};
|
|
1858
|
+
};
|
|
1859
|
+
};
|
|
1860
|
+
};
|
|
1861
|
+
listApiKeyStats: {
|
|
1862
|
+
parameters: {
|
|
1863
|
+
query?: {
|
|
1864
|
+
/** @description Scope filter (e.g. organization) */
|
|
1865
|
+
scope?: string | null;
|
|
1866
|
+
/** @description Number of days to analyze */
|
|
1867
|
+
days?: number;
|
|
1868
|
+
};
|
|
1869
|
+
header?: {
|
|
1870
|
+
authorization?: string | null;
|
|
1871
|
+
};
|
|
1872
|
+
path?: never;
|
|
1873
|
+
cookie?: never;
|
|
1874
|
+
};
|
|
1875
|
+
requestBody?: never;
|
|
1876
|
+
responses: {
|
|
1877
|
+
/** @description Successful Response */
|
|
1878
|
+
200: {
|
|
1879
|
+
headers: {
|
|
1880
|
+
[name: string]: unknown;
|
|
1881
|
+
};
|
|
1882
|
+
content: {
|
|
1883
|
+
"application/json": {
|
|
1884
|
+
[key: string]: unknown;
|
|
1885
|
+
};
|
|
1886
|
+
};
|
|
1887
|
+
};
|
|
1888
|
+
/** @description Validation Error */
|
|
1889
|
+
422: {
|
|
1890
|
+
headers: {
|
|
1891
|
+
[name: string]: unknown;
|
|
1892
|
+
};
|
|
1893
|
+
content: {
|
|
1894
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
1895
|
+
};
|
|
1896
|
+
};
|
|
1897
|
+
};
|
|
1898
|
+
};
|
|
1899
|
+
getApiKeyHealth: {
|
|
1900
|
+
parameters: {
|
|
1901
|
+
query?: never;
|
|
1902
|
+
header?: {
|
|
1903
|
+
authorization?: string | null;
|
|
1904
|
+
};
|
|
1905
|
+
path: {
|
|
1906
|
+
/** @description External API client ID */
|
|
1907
|
+
api_client_id: string;
|
|
1908
|
+
};
|
|
1909
|
+
cookie?: never;
|
|
1910
|
+
};
|
|
1911
|
+
requestBody?: never;
|
|
1912
|
+
responses: {
|
|
1913
|
+
/** @description Successful Response */
|
|
1914
|
+
200: {
|
|
1915
|
+
headers: {
|
|
1916
|
+
[name: string]: unknown;
|
|
1917
|
+
};
|
|
1918
|
+
content: {
|
|
1919
|
+
"application/json": {
|
|
1920
|
+
[key: string]: unknown;
|
|
1921
|
+
};
|
|
1922
|
+
};
|
|
1923
|
+
};
|
|
1924
|
+
/** @description Validation Error */
|
|
1925
|
+
422: {
|
|
1926
|
+
headers: {
|
|
1927
|
+
[name: string]: unknown;
|
|
1928
|
+
};
|
|
1929
|
+
content: {
|
|
1930
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
1931
|
+
};
|
|
1932
|
+
};
|
|
1933
|
+
};
|
|
1934
|
+
};
|
|
1935
|
+
listApiKeyAuditLogs: {
|
|
1936
|
+
parameters: {
|
|
1937
|
+
query?: {
|
|
1938
|
+
/** @description Page number (1-based) */
|
|
1939
|
+
page?: number;
|
|
1940
|
+
/** @description Items per page (1–500, default 50) */
|
|
1941
|
+
limit?: number;
|
|
1942
|
+
};
|
|
1943
|
+
header?: {
|
|
1944
|
+
authorization?: string | null;
|
|
1945
|
+
};
|
|
1946
|
+
path: {
|
|
1947
|
+
/** @description External API client ID (apicli_xxx) */
|
|
1948
|
+
api_client_id: string;
|
|
1949
|
+
};
|
|
1950
|
+
cookie?: never;
|
|
1951
|
+
};
|
|
1952
|
+
requestBody?: never;
|
|
1953
|
+
responses: {
|
|
1954
|
+
/** @description Successful Response */
|
|
1955
|
+
200: {
|
|
1956
|
+
headers: {
|
|
1957
|
+
[name: string]: unknown;
|
|
1958
|
+
};
|
|
1959
|
+
content: {
|
|
1960
|
+
"application/json": {
|
|
1961
|
+
[key: string]: unknown;
|
|
1962
|
+
};
|
|
1963
|
+
};
|
|
1964
|
+
};
|
|
1965
|
+
/** @description Validation Error */
|
|
1966
|
+
422: {
|
|
1967
|
+
headers: {
|
|
1968
|
+
[name: string]: unknown;
|
|
1969
|
+
};
|
|
1970
|
+
content: {
|
|
1971
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
1972
|
+
};
|
|
1973
|
+
};
|
|
1974
|
+
};
|
|
1975
|
+
};
|
|
1976
|
+
listOrgAuditLogs: {
|
|
1977
|
+
parameters: {
|
|
1978
|
+
query?: {
|
|
1979
|
+
/** @description Filter by action (created, updated, rotated, revoked, expired) */
|
|
1980
|
+
action?: string | null;
|
|
1981
|
+
/** @description Page number (1-based) */
|
|
1982
|
+
page?: number;
|
|
1983
|
+
/** @description Items per page (1–500, default 50) */
|
|
1984
|
+
limit?: number;
|
|
1985
|
+
};
|
|
1986
|
+
header?: {
|
|
1987
|
+
authorization?: string | null;
|
|
1988
|
+
};
|
|
1989
|
+
path?: never;
|
|
1990
|
+
cookie?: never;
|
|
1991
|
+
};
|
|
1992
|
+
requestBody?: never;
|
|
1993
|
+
responses: {
|
|
1994
|
+
/** @description Successful Response */
|
|
1995
|
+
200: {
|
|
1996
|
+
headers: {
|
|
1997
|
+
[name: string]: unknown;
|
|
1998
|
+
};
|
|
1999
|
+
content: {
|
|
2000
|
+
"application/json": {
|
|
2001
|
+
[key: string]: unknown;
|
|
2002
|
+
};
|
|
2003
|
+
};
|
|
2004
|
+
};
|
|
2005
|
+
/** @description Validation Error */
|
|
2006
|
+
422: {
|
|
2007
|
+
headers: {
|
|
2008
|
+
[name: string]: unknown;
|
|
2009
|
+
};
|
|
2010
|
+
content: {
|
|
2011
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
2012
|
+
};
|
|
2013
|
+
};
|
|
2014
|
+
};
|
|
2015
|
+
};
|
|
2016
|
+
checkAuditLogIntegrity: {
|
|
2017
|
+
parameters: {
|
|
2018
|
+
query?: never;
|
|
2019
|
+
header?: {
|
|
2020
|
+
authorization?: string | null;
|
|
2021
|
+
};
|
|
2022
|
+
path: {
|
|
2023
|
+
/** @description Audit log ID */
|
|
2024
|
+
log_id: number;
|
|
2025
|
+
};
|
|
2026
|
+
cookie?: never;
|
|
2027
|
+
};
|
|
2028
|
+
requestBody?: never;
|
|
2029
|
+
responses: {
|
|
2030
|
+
/** @description Successful Response */
|
|
2031
|
+
200: {
|
|
2032
|
+
headers: {
|
|
2033
|
+
[name: string]: unknown;
|
|
2034
|
+
};
|
|
2035
|
+
content: {
|
|
2036
|
+
"application/json": {
|
|
2037
|
+
[key: string]: unknown;
|
|
2038
|
+
};
|
|
2039
|
+
};
|
|
2040
|
+
};
|
|
2041
|
+
/** @description Validation Error */
|
|
2042
|
+
422: {
|
|
2043
|
+
headers: {
|
|
2044
|
+
[name: string]: unknown;
|
|
2045
|
+
};
|
|
2046
|
+
content: {
|
|
2047
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
2048
|
+
};
|
|
2049
|
+
};
|
|
2050
|
+
};
|
|
2051
|
+
};
|
|
2052
|
+
}
|
|
2053
|
+
//# sourceMappingURL=generated.d.ts.map
|