{"openapi":"3.0.3","info":{"title":"Paperless API","description":"Service businesses lose cash flow to slow approvals, manual chasing, and poor payer UX. AR Copilot is an AR-first invoicing platform with milestones/deposits, collaborative approvals, and workflow-driven collections that shortens DSO and reduces admin work.\n\n## Overview\nThe Paperless API provides programmatic access to manage invoices, payments, customers, and business workflows. Built for service businesses that need to accelerate cash flow and automate approval processes.\n\n## Key Features\n- **Invoice Management**: Create, update, and track invoices with automated workflows\n- **Payment Processing**: Handle payments, refunds, and financial reconciliation\n- **Customer Management**: Manage customer profiles, billing information, and communication preferences\n- **Analytics & Insights**: Access detailed analytics on payment trends, customer behavior, and business metrics\n- **Webhook Events**: Real-time notifications for invoice status changes, payments, and more\n- **Link Management**: Create and manage payment links with custom branding and tracking\n- **QR Code Generation**: Generate QR codes for quick payment collection\n- **Domain Management**: Configure custom domains for white-label experiences\n\n## Authentication\nAll API requests require authentication using a Bearer token. Include your API key in the Authorization header:\n```\nAuthorization: Bearer YOUR_API_KEY\n```\n\n## Rate Limiting\n- **Standard tier**: 100 requests per minute\n- **Professional tier**: 500 requests per minute\n- **Enterprise tier**: Custom limits available\n\nRate limit information is included in response headers:\n- `X-RateLimit-Limit`: Maximum requests allowed\n- `X-RateLimit-Remaining`: Requests remaining in current window\n- `X-RateLimit-Reset`: Unix timestamp when the limit resets\n\n## Error Handling\nThe API uses standard HTTP status codes and returns detailed error messages in JSON format:\n```json\n{\n  \"error\": {\n    \"code\": \"INVALID_REQUEST\",\n    \"message\": \"Description of the error\",\n    \"details\": {}\n  }\n}\n```\n\n## Pagination\nList endpoints support pagination using `page` and `pageSize` parameters:\n- `page`: Page number (default: 1)\n- `pageSize`: Items per page (default: 50, max: 100)\n\n## Webhooks\nConfigure webhooks to receive real-time notifications about events in your account. Supported events include:\n- Invoice created/updated/paid\n- Payment received/failed\n- Customer created/updated\n- Subscription status changes\n\n## SDKs & Libraries\nOfficial SDKs are available for:\n- JavaScript/TypeScript\n- Python\n- Ruby\n- PHP\n- Go\n\n## API Versioning\nThe API version is included in the URL path. We maintain backward compatibility within major versions and provide migration guides for breaking changes.\n\n## Support & Resources\n- Documentation: https://oppulence.app/docs\n- API Status: https://status.oppulence.app\n- Community Forum: https://community.oppulence.app\n- Email Support: support@oppulence.app","version":"1.0.0","termsOfService":"https://oppulence.app/terms","contact":{"name":"Paperless API Support","email":"support@oppulence.app","url":"https://oppulence.app/support"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"x-logo":{"url":"https://oppulence.app/api-logo.png","altText":"Paperless API"}},"servers":[{"url":"https://api.oppulence.app","description":"Production API","variables":{"protocol":{"enum":["https","http"],"default":"https","description":"Protocol for API requests"}}},{"url":"https://staging-api.oppulence.app","description":"Staging API (for testing)","variables":{"protocol":{"enum":["https","http"],"default":"https","description":"Protocol for API requests"}}},{"url":"http://localhost:3000","description":"Local development server"}],"tags":[{"name":"Invoices","description":"Manage invoices, quotes, and estimates","x-displayName":"Invoice Management"},{"name":"Payments","description":"Process payments and handle transactions","x-displayName":"Payment Processing"},{"name":"Customers","description":"Manage customer profiles and billing information","x-displayName":"Customer Management"},{"name":"Analytics","description":"Access business metrics and insights","x-displayName":"Analytics & Reporting"},{"name":"Links","description":"Create and manage payment links","x-displayName":"Payment Links"},{"name":"Webhooks","description":"Configure and manage webhook subscriptions","x-displayName":"Webhook Events"},{"name":"Domains","description":"Configure custom domains for white-label experiences","x-displayName":"Domain Management"},{"name":"QR Codes","description":"Generate and manage QR codes for payments","x-displayName":"QR Code Generation"}],"externalDocs":{"description":"Find more information in our developer documentation","url":"https://oppulence.app/developers"},"security":[{"token":[]}],"paths":{"/links":{"post":{"operationId":"createLink","x-speakeasy-name-override":"create","x-speakeasy-usage-example":true,"summary":"Create a new link","description":"Create a new link for the authenticated workspace.","tags":["Links"],"security":[{"token":[]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"domain":{"type":"string"},"key":{"type":"string","minLength":1,"maxLength":100},"type":{"type":"string","enum":["standard","smart","campaign","qr","bio","redirect"],"default":"standard"},"title":{"type":"string","maxLength":200},"description":{"type":"string","maxLength":1000},"image":{"type":"string","format":"uri"},"video":{"type":"string","format":"uri"},"expiresAt":{"type":"string"},"expiredUrl":{"type":"string","format":"uri"},"password":{"type":"string","minLength":6},"maxClicks":{"type":"number","minimum":0,"exclusiveMinimum":true},"trackConversion":{"type":"boolean","default":true},"publicStats":{"type":"boolean","default":false},"doIndex":{"type":"boolean","default":false},"proxy":{"type":"boolean","default":false},"utm":{"type":"object","properties":{"utm_source":{"type":"string","maxLength":100},"utm_medium":{"type":"string","maxLength":100},"utm_campaign":{"type":"string","maxLength":200},"utm_term":{"type":"string","maxLength":100},"utm_content":{"type":"string","maxLength":200}}},"deviceTargeting":{"type":"object","properties":{"ios":{"type":"string","format":"uri"},"android":{"type":"string","format":"uri"}}},"geoTargeting":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string","minLength":2,"maxLength":2},"url":{"type":"string","format":"uri"}},"required":["country","url"]}},"ios":{"type":"string","format":"uri"},"android":{"type":"string","format":"uri"},"geo":{"type":"object","additionalProperties":{"type":"string","format":"uri"}},"tags":{"type":"array","items":{"type":"string","maxLength":50},"maxItems":10},"tagId":{"type":"string"},"tagIds":{"type":"array","items":{"type":"string"}},"tagNames":{"type":"array","items":{"type":"string"}},"webhookIds":{"type":"array","items":{"type":"string"}},"category":{"type":"string","maxLength":100},"notes":{"type":"string","maxLength":1000}},"required":["url"]}}}},"responses":{"200":{"description":"The created link","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkSchema"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}},"get":{"operationId":"getLinks","x-speakeasy-name-override":"list","x-speakeasy-pagination":{"type":"offsetLimit","inputs":[{"name":"page","in":"parameters","type":"page"},{"name":"pageSize","in":"parameters","type":"limit"}],"outputs":{"results":"$"}},"summary":"Retrieve a list of links","description":"Retrieve a paginated list of links for the authenticated workspace.","tags":["Links"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"search","schema":{"type":"string"}},{"in":"query","name":"domain","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string","enum":["active","paused","expired","archived","deleted"]}},{"in":"query","name":"type","schema":{"type":"string","enum":["standard","smart","campaign","qr","bio","redirect"]}},{"in":"query","name":"hasPassword","schema":{"type":"boolean"}},{"in":"query","name":"isExpired","schema":{"type":"boolean"}},{"in":"query","name":"trackConversion","schema":{"type":"boolean"}},{"in":"query","name":"tags","schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}},{"in":"query","name":"tagId","schema":{"type":"string"}},{"in":"query","name":"tagIds","schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"tagNames","schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"category","schema":{"type":"string"}},{"in":"query","name":"minClicks","schema":{"type":"number","minimum":0}},{"in":"query","name":"maxClicks","schema":{"type":"number","minimum":0}},{"in":"query","name":"createdFrom","schema":{"type":"string"}},{"in":"query","name":"createdTo","schema":{"type":"string"}},{"in":"query","name":"expiresFrom","schema":{"type":"string"}},{"in":"query","name":"expiresTo","schema":{"type":"string"}},{"in":"query","name":"userId","schema":{"type":"string"}},{"in":"query","name":"showArchived","schema":{"type":"boolean"}},{"in":"query","name":"withTags","schema":{"type":"boolean"}},{"in":"query","name":"groupBy","schema":{"type":"string","enum":["link","domain","campaign","tag","country","userId","tagId"]}},{"in":"query","name":"linkIds","schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"tenantId","schema":{"type":"string"}},{"in":"query","name":"sort","schema":{"type":"string"}},{"in":"query","name":"includeUser","schema":{"type":"boolean"}},{"in":"query","name":"includeWebhooks","schema":{"type":"boolean"}},{"in":"query","name":"includeDashboard","schema":{"type":"boolean"}},{"in":"query","name":"page","schema":{"type":"integer","minimum":1,"default":1}},{"in":"query","name":"pageSize","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"in":"query","name":"sortBy","schema":{"type":"string","enum":["createdAt","clicks","uniqueClicks","leads","sales","lastClicked","expiresAt","saleAmount"],"default":"createdAt"}},{"in":"query","name":"sortOrder","schema":{"type":"string","enum":["asc","desc"],"default":"desc"}}],"responses":{"200":{"description":"A list of links","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LinkSchema"}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/links/count":{"get":{"operationId":"getLinksCount","x-speakeasy-name-override":"count","summary":"Retrieve links count","description":"Retrieve the number of links for the authenticated workspace.","tags":["Links"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"search","schema":{"type":"string"}},{"in":"query","name":"domain","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string","enum":["active","paused","expired","archived","deleted"]}},{"in":"query","name":"type","schema":{"type":"string","enum":["standard","smart","campaign","qr","bio","redirect"]}},{"in":"query","name":"hasPassword","schema":{"type":"boolean"}},{"in":"query","name":"isExpired","schema":{"type":"boolean"}},{"in":"query","name":"trackConversion","schema":{"type":"boolean"}},{"in":"query","name":"tags","schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}},{"in":"query","name":"tagId","schema":{"type":"string"}},{"in":"query","name":"tagIds","schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"tagNames","schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"category","schema":{"type":"string"}},{"in":"query","name":"minClicks","schema":{"type":"number","minimum":0}},{"in":"query","name":"maxClicks","schema":{"type":"number","minimum":0}},{"in":"query","name":"createdFrom","schema":{"type":"string"}},{"in":"query","name":"createdTo","schema":{"type":"string"}},{"in":"query","name":"expiresFrom","schema":{"type":"string"}},{"in":"query","name":"expiresTo","schema":{"type":"string"}},{"in":"query","name":"userId","schema":{"type":"string"}},{"in":"query","name":"showArchived","schema":{"type":"boolean"}},{"in":"query","name":"withTags","schema":{"type":"boolean"}},{"in":"query","name":"groupBy","schema":{"type":"string","enum":["link","domain","campaign","tag","country","userId","tagId"]}},{"in":"query","name":"linkIds","schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"tenantId","schema":{"type":"string"}},{"in":"query","name":"sort","schema":{"type":"string"}},{"in":"query","name":"includeUser","schema":{"type":"boolean"}},{"in":"query","name":"includeWebhooks","schema":{"type":"boolean"}},{"in":"query","name":"includeDashboard","schema":{"type":"boolean"}}],"responses":{"200":{"description":"A list of links","content":{"application/json":{"schema":{"type":"number","description":"The number of links matching the query."}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/links/info":{"get":{"operationId":"getLinkInfo","x-speakeasy-name-override":"get","summary":"Retrieve a link","description":"Retrieve the info for a link.","tags":["Links"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"domain","schema":{"type":"string"}},{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"linkId","schema":{"type":"string"}},{"in":"query","name":"externalId","schema":{"type":"string"}}],"responses":{"200":{"description":"The retrieved link","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkSchema"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/links/{linkId}":{"patch":{"operationId":"updateLink","x-speakeasy-name-override":"update","x-speakeasy-max-method-params":2,"summary":"Update a link","description":"Update a link for the authenticated workspace. If there's no change, returns it as it is.","tags":["Links"],"security":[{"token":[]}],"parameters":[{"in":"path","name":"linkId","description":"The id of the link to update. You may use either `linkId` (obtained via `/links/info` endpoint) or `externalId` prefixed with `ext_`.","schema":{"type":"string","description":"The id of the link to update. You may use either `linkId` (obtained via `/links/info` endpoint) or `externalId` prefixed with `ext_`."},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"domain":{"type":"string"},"key":{"type":"string","minLength":1,"maxLength":100},"type":{"type":"string","enum":["standard","smart","campaign","qr","bio","redirect"]},"title":{"type":"string","maxLength":200},"description":{"type":"string","maxLength":1000},"image":{"type":"string","format":"uri"},"video":{"type":"string","format":"uri"},"expiresAt":{"type":"string"},"expiredUrl":{"type":"string","format":"uri"},"password":{"type":"string","minLength":6},"maxClicks":{"type":"number","minimum":0,"exclusiveMinimum":true},"trackConversion":{"type":"boolean"},"publicStats":{"type":"boolean"},"doIndex":{"type":"boolean"},"proxy":{"type":"boolean"},"utm":{"type":"object","properties":{"utm_source":{"type":"string","maxLength":100},"utm_medium":{"type":"string","maxLength":100},"utm_campaign":{"type":"string","maxLength":200},"utm_term":{"type":"string","maxLength":100},"utm_content":{"type":"string","maxLength":200}}},"ios":{"type":"string","format":"uri"},"android":{"type":"string","format":"uri"},"geo":{"type":"object","additionalProperties":{"type":"string","format":"uri"}},"deviceTargeting":{"type":"object","properties":{"ios":{"type":"string","format":"uri"},"android":{"type":"string","format":"uri"}}},"geoTargeting":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string","minLength":2,"maxLength":2},"url":{"type":"string","format":"uri"}},"required":["country","url"]}},"tags":{"type":"array","items":{"type":"string","maxLength":50},"maxItems":10},"tagId":{"type":"string"},"tagIds":{"type":"array","items":{"type":"string"}},"tagNames":{"type":"array","items":{"type":"string"}},"webhookIds":{"type":"array","items":{"type":"string"}},"category":{"type":"string","maxLength":100},"notes":{"type":"string","maxLength":1000},"status":{"type":"string","enum":["active","paused","expired","archived","deleted"]},"archived":{"type":"boolean"}}}}}},"responses":{"200":{"description":"The updated link","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkSchema"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"deleteLink","x-speakeasy-name-override":"delete","x-speakeasy-max-method-params":1,"summary":"Delete a link","description":"Delete a link for the authenticated workspace.","tags":["Links"],"security":[{"token":[]}],"parameters":[{"in":"path","name":"linkId","description":"The id of the link to delete. You may use either `linkId` (obtained via `/links/info` endpoint) or `externalId` prefixed with `ext_`.","schema":{"type":"string","description":"The id of the link to delete. You may use either `linkId` (obtained via `/links/info` endpoint) or `externalId` prefixed with `ext_`."},"required":true}],"responses":{"200":{"description":"The deleted link ID.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the link."}},"required":["id"]}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/links/bulk":{"post":{"operationId":"bulkCreateLinks","x-speakeasy-name-override":"createMany","summary":"Bulk create links","description":"Bulk create up to 100 links for the authenticated workspace.","tags":["Links"],"security":[{"token":[]}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"domain":{"type":"string"},"key":{"type":"string","minLength":1,"maxLength":100},"type":{"type":"string","enum":["standard","smart","campaign","qr","bio","redirect"],"default":"standard"},"title":{"type":"string","maxLength":200},"description":{"type":"string","maxLength":1000},"image":{"type":"string","format":"uri"},"video":{"type":"string","format":"uri"},"expiresAt":{"type":"string"},"expiredUrl":{"type":"string","format":"uri"},"password":{"type":"string","minLength":6},"maxClicks":{"type":"number","minimum":0,"exclusiveMinimum":true},"trackConversion":{"type":"boolean","default":true},"publicStats":{"type":"boolean","default":false},"doIndex":{"type":"boolean","default":false},"proxy":{"type":"boolean","default":false},"utm":{"type":"object","properties":{"utm_source":{"type":"string","maxLength":100},"utm_medium":{"type":"string","maxLength":100},"utm_campaign":{"type":"string","maxLength":200},"utm_term":{"type":"string","maxLength":100},"utm_content":{"type":"string","maxLength":200}}},"deviceTargeting":{"type":"object","properties":{"ios":{"type":"string","format":"uri"},"android":{"type":"string","format":"uri"}}},"geoTargeting":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string","minLength":2,"maxLength":2},"url":{"type":"string","format":"uri"}},"required":["country","url"]}},"ios":{"type":"string","format":"uri"},"android":{"type":"string","format":"uri"},"geo":{"type":"object","additionalProperties":{"type":"string","format":"uri"}},"tags":{"type":"array","items":{"type":"string","maxLength":50},"maxItems":10},"tagId":{"type":"string"},"tagIds":{"type":"array","items":{"type":"string"}},"tagNames":{"type":"array","items":{"type":"string"}},"webhookIds":{"type":"array","items":{"type":"string"}},"category":{"type":"string","maxLength":100},"notes":{"type":"string","maxLength":1000}},"required":["url"]}}}}},"responses":{"200":{"description":"The created links","content":{"application/json":{"schema":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/LinkSchema"},{"$ref":"#/components/schemas/LinkErrorSchema"}]}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}},"patch":{"operationId":"bulkUpdateLinks","x-speakeasy-name-override":"updateMany","summary":"Bulk update links","description":"Bulk update up to 100 links with the same data for the authenticated workspace.","tags":["Links"],"security":[{"token":[]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"linkIds":{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":100,"default":[]},"externalIds":{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":100,"default":[]},"data":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"domain":{"type":"string"},"key":{"type":"string","minLength":1,"maxLength":100},"type":{"type":"string","enum":["standard","smart","campaign","qr","bio","redirect"]},"title":{"type":"string","maxLength":200},"description":{"type":"string","maxLength":1000},"image":{"type":"string","format":"uri"},"video":{"type":"string","format":"uri"},"expiresAt":{"type":"string"},"expiredUrl":{"type":"string","format":"uri"},"password":{"type":"string","minLength":6},"maxClicks":{"type":"number","minimum":0,"exclusiveMinimum":true},"trackConversion":{"type":"boolean"},"publicStats":{"type":"boolean"},"doIndex":{"type":"boolean"},"proxy":{"type":"boolean"},"utm":{"type":"object","properties":{"utm_source":{"type":"string","maxLength":100},"utm_medium":{"type":"string","maxLength":100},"utm_campaign":{"type":"string","maxLength":200},"utm_term":{"type":"string","maxLength":100},"utm_content":{"type":"string","maxLength":200}}},"ios":{"type":"string","format":"uri"},"android":{"type":"string","format":"uri"},"geo":{"type":"object","additionalProperties":{"type":"string","format":"uri"}},"deviceTargeting":{"type":"object","properties":{"ios":{"type":"string","format":"uri"},"android":{"type":"string","format":"uri"}}},"geoTargeting":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string","minLength":2,"maxLength":2},"url":{"type":"string","format":"uri"}},"required":["country","url"]}},"tags":{"type":"array","items":{"type":"string","maxLength":50},"maxItems":10},"tagId":{"type":"string"},"tagIds":{"type":"array","items":{"type":"string"}},"tagNames":{"type":"array","items":{"type":"string"}},"webhookIds":{"type":"array","items":{"type":"string"}},"category":{"type":"string","maxLength":100},"notes":{"type":"string","maxLength":1000},"status":{"type":"string","enum":["active","paused","expired","archived","deleted"]},"archived":{"type":"boolean"}}}},"required":["data"]}}}},"responses":{"200":{"description":"The updated links","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LinkSchema"}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"bulkDeleteLinks","x-speakeasy-name-override":"deleteMany","summary":"Bulk delete links","description":"Bulk delete up to 100 links for the authenticated workspace.","tags":["Links"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"linkIds","description":"Comma-separated list of link IDs to delete. Maximum of 100 IDs. Non-existing IDs will be ignored.","explode":false,"style":"form","schema":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of link IDs to delete. Maximum of 100 IDs. Non-existing IDs will be ignored.","example":["clux0rgak00011...","clux0rgak00022..."]},"required":true}],"responses":{"200":{"description":"The deleted links count.","content":{"application/json":{"schema":{"type":"object","properties":{"deletedCount":{"type":"number","description":"The number of links deleted."}},"required":["deletedCount"]}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/links/upsert":{"put":{"operationId":"upsertLink","x-speakeasy-name-override":"upsert","x-speakeasy-usage-example":true,"summary":"Upsert a link","description":"Upsert a link for the authenticated workspace by its URL. If a link with the same URL already exists, return it (or update it if there are any changes). Otherwise, a new link will be created.","tags":["Links"],"security":[{"token":[]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"domain":{"type":"string"},"key":{"type":"string","minLength":1,"maxLength":100},"type":{"type":"string","enum":["standard","smart","campaign","qr","bio","redirect"],"default":"standard"},"title":{"type":"string","maxLength":200},"description":{"type":"string","maxLength":1000},"image":{"type":"string","format":"uri"},"video":{"type":"string","format":"uri"},"expiresAt":{"type":"string"},"expiredUrl":{"type":"string","format":"uri"},"password":{"type":"string","minLength":6},"maxClicks":{"type":"number","minimum":0,"exclusiveMinimum":true},"trackConversion":{"type":"boolean","default":true},"publicStats":{"type":"boolean","default":false},"doIndex":{"type":"boolean","default":false},"proxy":{"type":"boolean","default":false},"utm":{"type":"object","properties":{"utm_source":{"type":"string","maxLength":100},"utm_medium":{"type":"string","maxLength":100},"utm_campaign":{"type":"string","maxLength":200},"utm_term":{"type":"string","maxLength":100},"utm_content":{"type":"string","maxLength":200}}},"deviceTargeting":{"type":"object","properties":{"ios":{"type":"string","format":"uri"},"android":{"type":"string","format":"uri"}}},"geoTargeting":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string","minLength":2,"maxLength":2},"url":{"type":"string","format":"uri"}},"required":["country","url"]}},"ios":{"type":"string","format":"uri"},"android":{"type":"string","format":"uri"},"geo":{"type":"object","additionalProperties":{"type":"string","format":"uri"}},"tags":{"type":"array","items":{"type":"string","maxLength":50},"maxItems":10},"tagId":{"type":"string"},"tagIds":{"type":"array","items":{"type":"string"}},"tagNames":{"type":"array","items":{"type":"string"}},"webhookIds":{"type":"array","items":{"type":"string"}},"category":{"type":"string","maxLength":100},"notes":{"type":"string","maxLength":1000}},"required":["url"]}}}},"responses":{"200":{"description":"The upserted link","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkSchema"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/analytics":{"get":{"operationId":"retrieveAnalytics","x-speakeasy-name-override":"retrieve","summary":"Retrieve analytics for a link, a domain, or the authenticated workspace.","description":"Retrieve analytics for a link, a domain, or the authenticated workspace. The response type depends on the `event` and `type` query parameters.","tags":["Analytics"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"event","description":"The type of event to retrieve analytics for. Defaults to `clicks`.","schema":{"type":"string","enum":["clicks","leads","sales","composite"],"default":"clicks","description":"The type of event to retrieve analytics for. Defaults to `clicks`."}},{"in":"query","name":"groupBy","description":"The parameter to group the analytics data points by. Defaults to `count` if undefined. Note that `trigger` is deprecated (use `triggers` instead), but kept for backwards compatibility.","schema":{"type":"string","enum":["count","timeseries","continents","regions","countries","cities","devices","browsers","os","trigger","triggers","referers","referer_urls","top_links","top_urls"],"default":"count","description":"The parameter to group the analytics data points by. Defaults to `count` if undefined. Note that `trigger` is deprecated (use `triggers` instead), but kept for backwards compatibility."}},{"in":"query","name":"domain","description":"The domain to filter analytics for.","schema":{"type":"string","description":"The domain to filter analytics for."}},{"in":"query","name":"key","description":"The short link slug.","schema":{"type":"string","description":"The short link slug."}},{"in":"query","name":"linkId","description":"The unique ID of the short link on Dub.","schema":{"type":"string","description":"The unique ID of the short link on Dub."}},{"in":"query","name":"externalId","description":"This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.","schema":{"type":"string","description":"This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter."}},{"in":"query","name":"interval","description":"The interval to retrieve analytics for. If undefined, defaults to 24h.","schema":{"type":"string","enum":["24h","7d","30d","90d","ytd","1y","all","all_unfiltered"],"description":"The interval to retrieve analytics for. If undefined, defaults to 24h."}},{"in":"query","name":"start","description":"The start date and time when to retrieve analytics from. Takes precedence over `interval`.","schema":{"type":"string","description":"The start date and time when to retrieve analytics from. Takes precedence over `interval`."}},{"in":"query","name":"end","description":"The end date and time when to retrieve analytics from. If not provided, defaults to the current date. Takes precedence over `interval`.","schema":{"type":"string","description":"The end date and time when to retrieve analytics from. If not provided, defaults to the current date. Takes precedence over `interval`."}},{"in":"query","name":"timezone","description":"The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.","schema":{"type":"string","description":"The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.","example":"America/New_York","default":"UTC"}},{"in":"query","name":"country","description":"The country to retrieve analytics for.","schema":{"$ref":"#/components/schemas/countryCode"}},{"in":"query","name":"city","description":"The city to retrieve analytics for.","schema":{"type":"string","description":"The city to retrieve analytics for.","example":"New York"}},{"in":"query","name":"region","description":"The ISO 3166-2 region code to retrieve analytics for.","schema":{"$ref":"#/components/schemas/regionCode"}},{"in":"query","name":"continent","description":"The continent to retrieve analytics for.","schema":{"$ref":"#/components/schemas/continentCode"}},{"in":"query","name":"device","description":"The device to retrieve analytics for.","schema":{"type":"string","description":"The device to retrieve analytics for.","example":"Desktop"}},{"in":"query","name":"browser","description":"The browser to retrieve analytics for.","schema":{"type":"string","description":"The browser to retrieve analytics for.","example":"Chrome"}},{"in":"query","name":"os","description":"The OS to retrieve analytics for.","schema":{"type":"string","description":"The OS to retrieve analytics for.","example":"Windows"}},{"in":"query","name":"trigger","description":"The trigger to retrieve analytics for. If undefined, return both QR and link clicks.","schema":{"type":"string","enum":["qr","link"],"description":"The trigger to retrieve analytics for. If undefined, return both QR and link clicks."}},{"in":"query","name":"referer","description":"The referer to retrieve analytics for.","schema":{"type":"string","description":"The referer to retrieve analytics for.","example":"google.com"}},{"in":"query","name":"refererUrl","description":"The full referer URL to retrieve analytics for.","schema":{"type":"string","description":"The full referer URL to retrieve analytics for.","example":"https://paperless.oppulence.app/blog"}},{"in":"query","name":"url","description":"The URL to retrieve analytics for.","schema":{"type":"string","description":"The URL to retrieve analytics for."}},{"in":"query","name":"tagId","description":"Deprecated. Use `tagIds` instead. The tag ID to retrieve analytics for.","schema":{"type":"string","description":"Deprecated. Use `tagIds` instead. The tag ID to retrieve analytics for.","deprecated":true}},{"in":"query","name":"tagIds","description":"The tag IDs to retrieve analytics for.","schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"The tag IDs to retrieve analytics for."}},{"in":"query","name":"qr","description":"Deprecated. Use the `trigger` field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.","schema":{"type":"boolean","description":"Deprecated. Use the `trigger` field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.","deprecated":true}},{"in":"query","name":"root","description":"Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both.","schema":{"type":"boolean","description":"Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both."}}],"responses":{"200":{"description":"Analytics data","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AnalyticsCount"},{"type":"array","items":{"$ref":"#/components/schemas/AnalyticsTimeseries"},"title":"AnalyticsTimeseries"},{"type":"array","items":{"$ref":"#/components/schemas/AnalyticsContinents"},"title":"AnalyticsContinents"},{"type":"array","items":{"$ref":"#/components/schemas/AnalyticsCountries"},"title":"AnalyticsCountries"},{"type":"array","items":{"$ref":"#/components/schemas/AnalyticsCities"},"title":"AnalyticsCities"},{"type":"array","items":{"$ref":"#/components/schemas/AnalyticsDevices"},"title":"AnalyticsDevices"},{"type":"array","items":{"$ref":"#/components/schemas/AnalyticsBrowsers"},"title":"AnalyticsBrowsers"},{"type":"array","items":{"$ref":"#/components/schemas/AnalyticsOS"},"title":"AnalyticsOS"},{"type":"array","items":{"$ref":"#/components/schemas/AnalyticsTriggers"},"title":"AnalyticsTriggers"},{"type":"array","items":{"$ref":"#/components/schemas/AnalyticsReferers"},"title":"AnalyticsReferers"},{"type":"array","items":{"$ref":"#/components/schemas/AnalyticsRefererUrls"},"title":"AnalyticsRefererUrls"},{"type":"array","items":{"$ref":"#/components/schemas/AnalyticsTopLinks"},"title":"AnalyticsTopLinks"},{"type":"array","items":{"$ref":"#/components/schemas/AnalyticsTopUrls"},"title":"AnalyticsTopUrls"}]}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/events":{"get":{"operationId":"listEvents","x-speakeasy-name-override":"list","summary":"Retrieve a list of events","description":"Retrieve a paginated list of events for the authenticated workspace.","tags":["Events"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"event","description":"The type of event to retrieve analytics for. Defaults to 'clicks'.","schema":{"type":"string","enum":["clicks","leads","sales"],"default":"clicks","description":"The type of event to retrieve analytics for. Defaults to 'clicks'."}},{"in":"query","name":"domain","description":"The domain to filter analytics for.","schema":{"type":"string","description":"The domain to filter analytics for."}},{"in":"query","name":"key","description":"The short link slug.","schema":{"type":"string","description":"The short link slug."}},{"in":"query","name":"linkId","description":"The unique ID of the short link on Dub.","schema":{"type":"string","description":"The unique ID of the short link on Dub."}},{"in":"query","name":"externalId","description":"This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.","schema":{"type":"string","description":"This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter."}},{"in":"query","name":"interval","description":"The interval to retrieve events for. Takes precedence over start and end. If undefined, defaults to 24h.","schema":{"type":"string","enum":["24h","7d","30d","90d","ytd","1y","all"],"default":"24h","description":"The interval to retrieve events for. Takes precedence over start and end. If undefined, defaults to 24h."}},{"in":"query","name":"start","description":"The start date and time when to retrieve analytics from. Takes precedence over `interval`.","schema":{"type":"string","description":"The start date and time when to retrieve analytics from. Takes precedence over `interval`."}},{"in":"query","name":"end","description":"The end date and time when to retrieve analytics from. If not provided, defaults to the current date. Takes precedence over `interval`.","schema":{"type":"string","description":"The end date and time when to retrieve analytics from. If not provided, defaults to the current date. Takes precedence over `interval`."}},{"in":"query","name":"timezone","description":"The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.","schema":{"type":"string","description":"The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.","example":"America/New_York","default":"UTC"}},{"in":"query","name":"country","description":"The country to retrieve analytics for.","schema":{"$ref":"#/components/schemas/countryCode"}},{"in":"query","name":"city","description":"The city to retrieve analytics for.","schema":{"type":"string","description":"The city to retrieve analytics for.","example":"New York"}},{"in":"query","name":"region","description":"The ISO 3166-2 region code to retrieve analytics for.","schema":{"$ref":"#/components/schemas/regionCode"}},{"in":"query","name":"continent","description":"The continent to retrieve analytics for.","schema":{"$ref":"#/components/schemas/continentCode"}},{"in":"query","name":"device","description":"The device to retrieve analytics for.","schema":{"type":"string","description":"The device to retrieve analytics for.","example":"Desktop"}},{"in":"query","name":"browser","description":"The browser to retrieve analytics for.","schema":{"type":"string","description":"The browser to retrieve analytics for.","example":"Chrome"}},{"in":"query","name":"os","description":"The OS to retrieve analytics for.","schema":{"type":"string","description":"The OS to retrieve analytics for.","example":"Windows"}},{"in":"query","name":"trigger","description":"The trigger to retrieve analytics for. If undefined, return both QR and link clicks.","schema":{"type":"string","enum":["qr","link"],"description":"The trigger to retrieve analytics for. If undefined, return both QR and link clicks."}},{"in":"query","name":"referer","description":"The referer to retrieve analytics for.","schema":{"type":"string","description":"The referer to retrieve analytics for.","example":"google.com"}},{"in":"query","name":"refererUrl","description":"The full referer URL to retrieve analytics for.","schema":{"type":"string","description":"The full referer URL to retrieve analytics for.","example":"https://paperless.oppulence.app/blog"}},{"in":"query","name":"url","description":"The URL to retrieve analytics for.","schema":{"type":"string","description":"The URL to retrieve analytics for."}},{"in":"query","name":"tagId","description":"Deprecated. Use `tagIds` instead. The tag ID to retrieve analytics for.","schema":{"type":"string","description":"Deprecated. Use `tagIds` instead. The tag ID to retrieve analytics for.","deprecated":true}},{"in":"query","name":"tagIds","description":"The tag IDs to retrieve analytics for.","schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"The tag IDs to retrieve analytics for."}},{"in":"query","name":"qr","description":"Deprecated. Use the `trigger` field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.","schema":{"type":"boolean","description":"Deprecated. Use the `trigger` field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.","deprecated":true}},{"in":"query","name":"root","description":"Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both.","schema":{"type":"boolean","description":"Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both."}},{"in":"query","name":"page","schema":{"type":"number","default":1}},{"in":"query","name":"limit","schema":{"type":"number","default":100}},{"in":"query","name":"sortOrder","description":"The sort order. The default is `desc`.","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"The sort order. The default is `desc`."}},{"in":"query","name":"sortBy","description":"The field to sort the events by. The default is `timestamp`.","schema":{"type":"string","enum":["timestamp"],"default":"timestamp","description":"The field to sort the events by. The default is `timestamp`."}},{"in":"query","name":"order","description":"DEPRECATED. Use `sortOrder` instead.","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"DEPRECATED. Use `sortOrder` instead.","deprecated":true}}],"responses":{"200":{"description":"A list of events","content":{"application/json":{"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/ClickEvent"},"title":"ClickEvents"},{"type":"array","items":{"$ref":"#/components/schemas/LeadEvent"},"title":"LeadEvents"},{"type":"array","items":{"$ref":"#/components/schemas/SaleEvent"},"title":"SaleEvents"}]}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/tags":{"post":{"operationId":"createTag","x-speakeasy-name-override":"create","summary":"Create a new tag","description":"Create a new tag for the authenticated workspace.","tags":["Tags"],"security":[{"token":[]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":50,"description":"The name of the tag to create."},"color":{"type":"string","enum":["red","yellow","green","blue","purple","pink","brown"],"description":"The color of the tag. If not provided, a random color will be used from the list: red, yellow, green, blue, purple, pink, brown."},"tag":{"type":"string","minLength":1,"description":"The name of the tag to create.","deprecated":true}}}}}},"responses":{"201":{"description":"The created tag","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagSchema"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}},"get":{"operationId":"getTags","x-speakeasy-name-override":"list","summary":"Retrieve a list of tags","description":"Retrieve a list of tags for the authenticated workspace.","tags":["Tags"],"security":[{"token":[]}],"responses":{"200":{"description":"A list of tags","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TagSchema"}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/tags/{id}":{"patch":{"operationId":"updateTag","x-speakeasy-name-override":"update","x-speakeasy-max-method-params":2,"summary":"Update a tag","description":"Update a tag in the workspace.","tags":["Tags"],"security":[{"token":[]}],"parameters":[{"in":"path","name":"id","description":"The ID of the tag to update.","schema":{"type":"string","description":"The ID of the tag to update."},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":50,"description":"The name of the tag to create."},"color":{"type":"string","enum":["red","yellow","green","blue","purple","pink","brown"],"description":"The color of the tag. If not provided, a random color will be used from the list: red, yellow, green, blue, purple, pink, brown."},"tag":{"type":"string","minLength":1,"description":"The name of the tag to create.","deprecated":true}}}}}},"responses":{"200":{"description":"The updated tag.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagSchema"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"deleteTag","x-speakeasy-name-override":"delete","x-speakeasy-max-method-params":1,"summary":"Delete a tag","description":"Delete a tag from the workspace. All existing links will still work, but they will no longer be associated with this tag.","tags":["Tags"],"security":[{"token":[]}],"parameters":[{"in":"path","name":"id","description":"The ID of the tag to delete.","schema":{"type":"string","description":"The ID of the tag to delete."},"required":true}],"responses":{"200":{"description":"The deleted tag ID.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the deleted tag."}},"required":["id"]}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/domains":{"post":{"operationId":"createDomain","x-speakeasy-name-override":"create","summary":"Create a domain","description":"Create a domain for the authenticated workspace.","tags":["Domains"],"security":[{"token":[]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":190,"description":"Name of the domain.","example":"acme.com"},"expiredUrl":{"type":"string","nullable":true,"description":"Redirect users to a specific URL when any link under this domain has expired.","example":"https://acme.com/expired"},"notFoundUrl":{"type":"string","nullable":true,"description":"Redirect users to a specific URL when a link under this domain doesn't exist.","example":"https://acme.com/not-found"},"archived":{"type":"boolean","default":false,"description":"Whether to archive this domain. `false` will unarchive a previously archived domain.","example":false},"placeholder":{"type":"string","nullable":true,"maxLength":100,"description":"Provide context to your teammates in the link creation modal by showing them an example of a link to be shortened.","example":"https://paperless.oppulence.app/help/article/what-is-dub"},"logo":{"type":"string","nullable":true,"description":"The logo of the domain."}},"required":["slug"]}}}},"responses":{"201":{"description":"The domain was created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainSchema"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}},"get":{"operationId":"listDomains","x-speakeasy-name-override":"list","x-speakeasy-pagination":{"type":"offsetLimit","inputs":[{"name":"page","in":"parameters","type":"page"},{"name":"pageSize","in":"parameters","type":"limit"}],"outputs":{"results":"$"}},"summary":"Retrieve a list of domains","description":"Retrieve a list of domains associated with the authenticated workspace.","tags":["Domains"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"archived","description":"Whether to include archived domains in the response. Defaults to `false` if not provided.","schema":{"type":"boolean","default":"false","description":"Whether to include archived domains in the response. Defaults to `false` if not provided."}},{"in":"query","name":"search","description":"The search term to filter the domains by.","schema":{"type":"string","description":"The search term to filter the domains by."}},{"in":"query","name":"page","description":"The page number for pagination.","schema":{"type":"number","minimum":0,"exclusiveMinimum":true,"default":1,"description":"The page number for pagination.","example":1}},{"in":"query","name":"pageSize","description":"The number of items per page.","schema":{"type":"number","minimum":0,"exclusiveMinimum":true,"maximum":50,"default":50,"description":"The number of items per page.","example":50}}],"responses":{"200":{"description":"The domains were retrieved.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DomainSchema"}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/domains/{slug}":{"patch":{"operationId":"updateDomain","x-speakeasy-name-override":"update","x-speakeasy-max-method-params":2,"summary":"Update a domain","description":"Update a domain for the authenticated workspace.","tags":["Domains"],"security":[{"token":[]}],"parameters":[{"in":"path","name":"slug","description":"The domain name.","schema":{"type":"string","description":"The domain name.","example":"acme.com"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":190,"description":"Name of the domain.","example":"acme.com"},"expiredUrl":{"type":"string","nullable":true,"description":"Redirect users to a specific URL when any link under this domain has expired.","example":"https://acme.com/expired"},"notFoundUrl":{"type":"string","nullable":true,"description":"Redirect users to a specific URL when a link under this domain doesn't exist.","example":"https://acme.com/not-found"},"archived":{"type":"boolean","default":false,"description":"Whether to archive this domain. `false` will unarchive a previously archived domain.","example":false},"placeholder":{"type":"string","nullable":true,"maxLength":100,"description":"Provide context to your teammates in the link creation modal by showing them an example of a link to be shortened.","example":"https://paperless.oppulence.app/help/article/what-is-dub"},"logo":{"type":"string","nullable":true,"description":"The logo of the domain."}}}}}},"responses":{"200":{"description":"The domain was updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainSchema"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"deleteDomain","x-speakeasy-name-override":"delete","x-speakeasy-max-method-params":1,"summary":"Delete a domain","description":"Delete a domain from a workspace. It cannot be undone. This will also delete all the links associated with the domain.","tags":["Domains"],"security":[{"token":[]}],"parameters":[{"in":"path","name":"slug","description":"The domain name.","schema":{"type":"string","description":"The domain name.","example":"acme.com"},"required":true}],"responses":{"200":{"description":"The domain was deleted.","content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string","description":"The domain name.","example":"acme.com"}},"required":["slug"]}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/track/lead":{"post":{"operationId":"trackLead","x-speakeasy-name-override":"lead","summary":"Track a lead","description":"Track a lead for a short link.","tags":["Track"],"security":[{"token":[]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"clickId":{"type":"string","minLength":1,"description":"The ID of the click in th Dub. You can read this value from `dub_id` cookie."},"eventName":{"type":"string","minLength":1,"maxLength":50,"description":"The name of the event to track.","example":"Sign up"},"externalId":{"type":"string","maxLength":100,"default":"","description":"This is the unique identifier for the customer in the client's app. This is used to track the customer's journey."},"customerId":{"type":"string","nullable":true,"maxLength":100,"default":null,"description":"This is the unique identifier for the customer in the client's app. This is used to track the customer's journey.","deprecated":true},"customerName":{"type":"string","nullable":true,"maxLength":100,"default":null,"description":"Name of the customer in the client's app."},"customerEmail":{"type":"string","nullable":true,"format":"email","maxLength":100,"default":null,"description":"Email of the customer in the client's app."},"customerAvatar":{"type":"string","nullable":true,"default":null,"description":"Avatar of the customer in the client's app."},"metadata":{"type":"object","nullable":true,"additionalProperties":{},"default":null,"description":"Additional metadata to be stored with the lead event"}},"required":["clickId","eventName"]}}}},"responses":{"200":{"description":"A lead was tracked.","content":{"application/json":{"schema":{"type":"object","properties":{"click":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"customer":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"avatar":{"type":"string","nullable":true},"externalId":{"type":"string","nullable":true}},"required":["name","email","avatar","externalId"]}},"required":["click","customer"]}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/track/sale":{"post":{"operationId":"trackSale","x-speakeasy-name-override":"sale","summary":"Track a sale","description":"Track a sale for a short link.","tags":["Track"],"security":[{"token":[]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"externalId":{"type":"string","maxLength":100,"default":"","description":"This is the unique identifier for the customer in the client's app. This is used to track the customer's journey."},"customerId":{"type":"string","nullable":true,"maxLength":100,"default":null,"description":"This is the unique identifier for the customer in the client's app. This is used to track the customer's journey.","deprecated":true},"amount":{"type":"integer","minimum":0,"description":"The amount of the sale. Should be passed in cents."},"paymentProcessor":{"type":"string","enum":["stripe","shopify","paddle"],"description":"The payment processor via which the sale was made."},"eventName":{"type":"string","maxLength":50,"default":"Purchase","description":"The name of the sale event. It can be used to track different types of event for example 'Purchase', 'Upgrade', 'Payment', etc.","example":"Purchase"},"invoiceId":{"type":"string","nullable":true,"default":null,"description":"The invoice ID of the sale."},"currency":{"type":"string","default":"usd","description":"The currency of the sale. Accepts ISO 4217 currency codes."},"metadata":{"type":"object","nullable":true,"additionalProperties":{},"default":null,"description":"Additional metadata to be stored with the sale event."}},"required":["amount","paymentProcessor"]}}}},"responses":{"200":{"description":"A sale was tracked.","content":{"application/json":{"schema":{"type":"object","properties":{"eventName":{"type":"string"},"customer":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"avatar":{"type":"string","nullable":true},"externalId":{"type":"string","nullable":true}},"required":["id","name","email","avatar","externalId"]},"sale":{"type":"object","properties":{"amount":{"type":"number"},"currency":{"type":"string"},"paymentProcessor":{"type":"string"},"invoiceId":{"type":"string","nullable":true},"metadata":{"type":"object","nullable":true,"additionalProperties":{}}},"required":["amount","currency","paymentProcessor","invoiceId","metadata"]}},"required":["eventName","customer","sale"]}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/customers":{"get":{"operationId":"getCustomers","x-speakeasy-name-override":"list","summary":"Retrieve a list of customers","description":"Retrieve a list of customers for the authenticated workspace.","tags":["Customers"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"search","schema":{"type":"string"}},{"in":"query","name":"ids","schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"email","schema":{"type":"string","format":"email"}},{"in":"query","name":"externalId","schema":{"type":"string"}},{"in":"query","name":"type","schema":{"type":"string","enum":["individual","business","enterprise","partner"]}},{"in":"query","name":"status","schema":{"type":"string","enum":["active","inactive","pending","suspended","closed"]}},{"in":"query","name":"segment","schema":{"type":"string","enum":["small","medium","large","enterprise","strategic"]}},{"in":"query","name":"lifecycleStage","schema":{"type":"string","enum":["lead","prospect","opportunity","customer","evangelist","churned","reactivated"]}},{"in":"query","name":"priority","schema":{"type":"string","enum":["low","medium","high","vip"]}},{"in":"query","name":"source","schema":{"type":"string","enum":["organic","paid_search","social_media","email","referral","partner","direct","event","cold_outreach","other"]}},{"in":"query","name":"assignedTo","schema":{"type":"string"}},{"in":"query","name":"minLeadScore","schema":{"type":"number","minimum":0,"maximum":100}},{"in":"query","name":"maxLeadScore","schema":{"type":"number","minimum":0,"maximum":100}},{"in":"query","name":"minLifetimeValue","schema":{"type":"number","minimum":0}},{"in":"query","name":"maxLifetimeValue","schema":{"type":"number","minimum":0}},{"in":"query","name":"hasInteractions","schema":{"type":"boolean"}},{"in":"query","name":"lastInteractionFrom","schema":{"type":"string"}},{"in":"query","name":"lastInteractionTo","schema":{"type":"string"}},{"in":"query","name":"tags","schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}},{"in":"query","name":"createdFrom","schema":{"type":"string"}},{"in":"query","name":"createdTo","schema":{"type":"string"}},{"in":"query","name":"page","schema":{"type":"integer","minimum":1,"default":1}},{"in":"query","name":"pageSize","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"in":"query","name":"sortBy","schema":{"type":"string","enum":["name","email","createdAt","updatedAt","leadScore","healthScore","lifetimeValue","lastInteraction"],"default":"createdAt"}},{"in":"query","name":"sortOrder","schema":{"type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"includeInteractions","schema":{"type":"boolean","default":false}},{"in":"query","name":"includeAnalytics","schema":{"type":"boolean","default":false}},{"in":"query","name":"includeExpandedFields","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The list of customers.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"avatar":{"type":"string","nullable":true},"externalId":{"type":"string","nullable":true},"stripeCustomerId":{"type":"string","nullable":true},"linkId":{"type":"string","nullable":true},"clickId":{"type":"string","nullable":true},"clickedAt":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"projectId":{"type":"string"},"projectConnectId":{"type":"string","nullable":true},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"addressLine1":{"type":"string","nullable":true},"addressLine2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"contact":{"type":"string","nullable":true},"countryCode":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"zip":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"vatNumber":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"companyName":{"type":"string","nullable":true},"tradingName":{"type":"string","nullable":true},"registrationNumber":{"type":"string","nullable":true},"isVendor":{"type":"boolean"},"alternativePhone":{"type":"string","nullable":true},"fax":{"type":"string","nullable":true},"contactTitle":{"type":"string","nullable":true},"contactEmail":{"type":"string","nullable":true},"contactPhone":{"type":"string","nullable":true},"billingAddressLine1":{"type":"string","nullable":true},"billingAddressLine2":{"type":"string","nullable":true},"billingCity":{"type":"string","nullable":true},"billingState":{"type":"string","nullable":true},"billingZip":{"type":"string","nullable":true},"billingCountryCode":{"type":"string","nullable":true},"billingEmail":{"type":"string","nullable":true},"taxId":{"type":"string","nullable":true},"taxExempt":{"type":"boolean"},"taxExemptionNumber":{"type":"string","nullable":true},"currency":{"type":"string","nullable":true},"preferredPaymentMethod":{"type":"string","nullable":true},"paymentTerms":{"type":"string","nullable":true},"creditLimit":{"nullable":true},"bankName":{"type":"string","nullable":true},"bankAccountName":{"type":"string","nullable":true},"bankAccountNumber":{"type":"string","nullable":true},"bankRoutingNumber":{"type":"string","nullable":true},"bankSwiftCode":{"type":"string","nullable":true},"bankIban":{"type":"string","nullable":true},"industry":{"type":"string","nullable":true},"customerType":{"type":"string","nullable":true},"customerStatus":{"type":"string","nullable":true},"customerRating":{"type":"number","nullable":true},"discountTerms":{"type":"string","nullable":true},"latePaymentPenalty":{"nullable":true},"creditScore":{"type":"number","nullable":true},"customFields":{"type":"object","nullable":true,"additionalProperties":{}},"lastOrderDate":{"type":"string","nullable":true},"accountManager":{"type":"string","nullable":true},"shippingAddresses":{"type":"string","nullable":true},"billingAddresses":{"type":"string","nullable":true},"warehouseAddresses":{"type":"string","nullable":true},"billingCurrency":{"type":"string","nullable":true},"billingCycle":{"type":"string","nullable":true},"invoiceDeliveryMethod":{"type":"string","nullable":true},"invoiceFormat":{"type":"string","nullable":true},"purchaseOrderRequired":{"type":"boolean"},"autoInvoice":{"type":"boolean"},"taxExemptionExpiry":{"type":"string","nullable":true},"taxJurisdiction":{"type":"string","nullable":true},"taxClassification":{"type":"string","nullable":true},"withholdingTaxRate":{"nullable":true},"taxDocuments":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"type":{"type":"string"},"jurisdiction":{"type":"string"},"issuedBy":{"type":"string"},"validFrom":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"validTo":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"url":{"type":"string","format":"uri"}}}},"availableCredit":{"nullable":true},"riskRating":{"type":"string","nullable":true},"insurancePolicy":{"type":"string","nullable":true},"insuranceExpiry":{"type":"string","nullable":true},"insuranceCoverage":{"nullable":true},"earlyPaymentDiscount":{"nullable":true},"minimumOrderValue":{"nullable":true},"maximumOrderValue":{"nullable":true},"averagePaymentDays":{"type":"number","nullable":true},"paymentFrequency":{"type":"string","nullable":true},"bankAccounts":{"type":"array","nullable":true,"items":{"type":"object","properties":{"bankName":{"type":"string"},"holderName":{"type":"string"},"accountNumber":{"type":"string"},"routingNumber":{"type":"string"},"swift":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"type":{"type":"string"},"isPrimary":{"type":"boolean"}}}},"contractStartDate":{"type":"string","nullable":true},"contractEndDate":{"type":"string","nullable":true},"contractRenewalDate":{"type":"string","nullable":true},"contractStatus":{"type":"string","nullable":true},"legalStatus":{"type":"string","nullable":true},"complianceStatus":{"type":"string","nullable":true},"certifications":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"issuer":{"type":"string"},"issuedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"expiresAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"url":{"type":"string","format":"uri"}},"required":["name"]}},"licenses":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"number":{"type":"string"},"issuer":{"type":"string"},"issuedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"expiresAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"url":{"type":"string","format":"uri"}},"required":["name"]}},"ndaStatus":{"type":"boolean"},"ndaExpiryDate":{"type":"string","nullable":true},"customerSegment":{"type":"string","nullable":true},"accountTier":{"type":"string","nullable":true},"leadSource":{"type":"string","nullable":true},"marketingCampaigns":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"source":{"type":"string"},"medium":{"type":"string"},"campaignId":{"type":"string"},"channel":{"type":"string"},"startedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"endedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"budget":{"type":"number","minimum":0},"spend":{"type":"number","minimum":0},"clicks":{"type":"integer","minimum":0},"conversions":{"type":"integer","minimum":0}},"required":["name"]}},"preferredLanguage":{"type":"string","nullable":true},"communicationPreferences":{"type":"object","nullable":true,"properties":{"email":{"type":"object","properties":{"newsletters":{"type":"boolean","default":false},"promotions":{"type":"boolean","default":false},"productUpdates":{"type":"boolean","default":true}}},"phone":{"type":"object","properties":{"sms":{"type":"boolean","default":false},"calls":{"type":"boolean","default":false}}},"channels":{"type":"array","items":{"type":"string"}},"preferredLanguage":{"type":"string"},"preferredTimes":{"type":"array","items":{"type":"string"}}}},"subscriptionStatus":{"type":"string","nullable":true},"loyaltyPoints":{"type":"number","nullable":true},"referralSource":{"type":"string","nullable":true},"referralCode":{"type":"string","nullable":true},"lifetimeValue":{"nullable":true},"acquisitionCost":{"nullable":true},"retentionRate":{"nullable":true},"satisfactionScore":{"type":"number","nullable":true},"lastReviewDate":{"type":"string","nullable":true},"nextReviewDate":{"type":"string","nullable":true},"erpId":{"type":"string","nullable":true},"crmId":{"type":"string","nullable":true},"accountingId":{"type":"string","nullable":true},"lastLoginDate":{"type":"string","nullable":true},"lastInteractionDate":{"type":"string","nullable":true},"totalOrders":{"type":"number","nullable":true},"totalReturns":{"type":"number","nullable":true},"activeSubscriptions":{"type":"number","nullable":true},"metadata":{"type":"object","nullable":true,"additionalProperties":{}},"notes":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"author":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"email":{"type":"string","format":"email"}}},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"visibility":{"type":"string","enum":["internal","public"],"default":"internal"},"content":{"type":"string"}},"required":["content"]}}},"required":["id","name","email","avatar","externalId","stripeCustomerId","linkId","clickId","clickedAt","country","projectId","projectConnectId","createdAt","updatedAt","addressLine1","addressLine2","city","contact","countryCode","state","zip","note","phone","token","vatNumber","website","companyName","tradingName","registrationNumber","isVendor","alternativePhone","fax","contactTitle","contactEmail","contactPhone","billingAddressLine1","billingAddressLine2","billingCity","billingState","billingZip","billingCountryCode","billingEmail","taxId","taxExempt","taxExemptionNumber","currency","preferredPaymentMethod","paymentTerms","bankName","bankAccountName","bankAccountNumber","bankRoutingNumber","bankSwiftCode","bankIban","industry","customerType","customerStatus","customerRating","discountTerms","creditScore","customFields","lastOrderDate","accountManager","shippingAddresses","billingAddresses","warehouseAddresses","billingCurrency","billingCycle","invoiceDeliveryMethod","invoiceFormat","purchaseOrderRequired","autoInvoice","taxExemptionExpiry","taxJurisdiction","taxClassification","taxDocuments","riskRating","insurancePolicy","insuranceExpiry","averagePaymentDays","paymentFrequency","bankAccounts","contractStartDate","contractEndDate","contractRenewalDate","contractStatus","legalStatus","complianceStatus","certifications","licenses","ndaStatus","ndaExpiryDate","customerSegment","accountTier","leadSource","marketingCampaigns","preferredLanguage","communicationPreferences","subscriptionStatus","loyaltyPoints","referralSource","referralCode","satisfactionScore","lastReviewDate","nextReviewDate","erpId","crmId","accountingId","lastLoginDate","lastInteractionDate","totalOrders","totalReturns","activeSubscriptions","metadata","notes"]}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}},"post":{"operationId":"createCustomer","x-speakeasy-name-override":"create","summary":"Create a customer","description":"Create a customer for the authenticated workspace.","tags":["Customers"],"security":[{"token":[]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email"},"name":{"type":"string"},"avatar":{"type":"string"},"externalId":{"type":"string"}}}}}},"responses":{"201":{"description":"The customer was created.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"avatar":{"type":"string","nullable":true},"externalId":{"type":"string","nullable":true},"stripeCustomerId":{"type":"string","nullable":true},"linkId":{"type":"string","nullable":true},"clickId":{"type":"string","nullable":true},"clickedAt":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"projectId":{"type":"string"},"projectConnectId":{"type":"string","nullable":true},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"addressLine1":{"type":"string","nullable":true},"addressLine2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"contact":{"type":"string","nullable":true},"countryCode":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"zip":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"vatNumber":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"companyName":{"type":"string","nullable":true},"tradingName":{"type":"string","nullable":true},"registrationNumber":{"type":"string","nullable":true},"isVendor":{"type":"boolean"},"alternativePhone":{"type":"string","nullable":true},"fax":{"type":"string","nullable":true},"contactTitle":{"type":"string","nullable":true},"contactEmail":{"type":"string","nullable":true},"contactPhone":{"type":"string","nullable":true},"billingAddressLine1":{"type":"string","nullable":true},"billingAddressLine2":{"type":"string","nullable":true},"billingCity":{"type":"string","nullable":true},"billingState":{"type":"string","nullable":true},"billingZip":{"type":"string","nullable":true},"billingCountryCode":{"type":"string","nullable":true},"billingEmail":{"type":"string","nullable":true},"taxId":{"type":"string","nullable":true},"taxExempt":{"type":"boolean"},"taxExemptionNumber":{"type":"string","nullable":true},"currency":{"type":"string","nullable":true},"preferredPaymentMethod":{"type":"string","nullable":true},"paymentTerms":{"type":"string","nullable":true},"creditLimit":{"nullable":true},"bankName":{"type":"string","nullable":true},"bankAccountName":{"type":"string","nullable":true},"bankAccountNumber":{"type":"string","nullable":true},"bankRoutingNumber":{"type":"string","nullable":true},"bankSwiftCode":{"type":"string","nullable":true},"bankIban":{"type":"string","nullable":true},"industry":{"type":"string","nullable":true},"customerType":{"type":"string","nullable":true},"customerStatus":{"type":"string","nullable":true},"customerRating":{"type":"number","nullable":true},"discountTerms":{"type":"string","nullable":true},"latePaymentPenalty":{"nullable":true},"creditScore":{"type":"number","nullable":true},"customFields":{"type":"object","nullable":true,"additionalProperties":{}},"lastOrderDate":{"type":"string","nullable":true},"accountManager":{"type":"string","nullable":true},"shippingAddresses":{"type":"string","nullable":true},"billingAddresses":{"type":"string","nullable":true},"warehouseAddresses":{"type":"string","nullable":true},"billingCurrency":{"type":"string","nullable":true},"billingCycle":{"type":"string","nullable":true},"invoiceDeliveryMethod":{"type":"string","nullable":true},"invoiceFormat":{"type":"string","nullable":true},"purchaseOrderRequired":{"type":"boolean"},"autoInvoice":{"type":"boolean"},"taxExemptionExpiry":{"type":"string","nullable":true},"taxJurisdiction":{"type":"string","nullable":true},"taxClassification":{"type":"string","nullable":true},"withholdingTaxRate":{"nullable":true},"taxDocuments":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"type":{"type":"string"},"jurisdiction":{"type":"string"},"issuedBy":{"type":"string"},"validFrom":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"validTo":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"url":{"type":"string","format":"uri"}}}},"availableCredit":{"nullable":true},"riskRating":{"type":"string","nullable":true},"insurancePolicy":{"type":"string","nullable":true},"insuranceExpiry":{"type":"string","nullable":true},"insuranceCoverage":{"nullable":true},"earlyPaymentDiscount":{"nullable":true},"minimumOrderValue":{"nullable":true},"maximumOrderValue":{"nullable":true},"averagePaymentDays":{"type":"number","nullable":true},"paymentFrequency":{"type":"string","nullable":true},"bankAccounts":{"type":"array","nullable":true,"items":{"type":"object","properties":{"bankName":{"type":"string"},"holderName":{"type":"string"},"accountNumber":{"type":"string"},"routingNumber":{"type":"string"},"swift":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"type":{"type":"string"},"isPrimary":{"type":"boolean"}}}},"contractStartDate":{"type":"string","nullable":true},"contractEndDate":{"type":"string","nullable":true},"contractRenewalDate":{"type":"string","nullable":true},"contractStatus":{"type":"string","nullable":true},"legalStatus":{"type":"string","nullable":true},"complianceStatus":{"type":"string","nullable":true},"certifications":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"issuer":{"type":"string"},"issuedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"expiresAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"url":{"type":"string","format":"uri"}},"required":["name"]}},"licenses":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"number":{"type":"string"},"issuer":{"type":"string"},"issuedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"expiresAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"url":{"type":"string","format":"uri"}},"required":["name"]}},"ndaStatus":{"type":"boolean"},"ndaExpiryDate":{"type":"string","nullable":true},"customerSegment":{"type":"string","nullable":true},"accountTier":{"type":"string","nullable":true},"leadSource":{"type":"string","nullable":true},"marketingCampaigns":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"source":{"type":"string"},"medium":{"type":"string"},"campaignId":{"type":"string"},"channel":{"type":"string"},"startedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"endedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"budget":{"type":"number","minimum":0},"spend":{"type":"number","minimum":0},"clicks":{"type":"integer","minimum":0},"conversions":{"type":"integer","minimum":0}},"required":["name"]}},"preferredLanguage":{"type":"string","nullable":true},"communicationPreferences":{"type":"object","nullable":true,"properties":{"email":{"type":"object","properties":{"newsletters":{"type":"boolean","default":false},"promotions":{"type":"boolean","default":false},"productUpdates":{"type":"boolean","default":true}}},"phone":{"type":"object","properties":{"sms":{"type":"boolean","default":false},"calls":{"type":"boolean","default":false}}},"channels":{"type":"array","items":{"type":"string"}},"preferredLanguage":{"type":"string"},"preferredTimes":{"type":"array","items":{"type":"string"}}}},"subscriptionStatus":{"type":"string","nullable":true},"loyaltyPoints":{"type":"number","nullable":true},"referralSource":{"type":"string","nullable":true},"referralCode":{"type":"string","nullable":true},"lifetimeValue":{"nullable":true},"acquisitionCost":{"nullable":true},"retentionRate":{"nullable":true},"satisfactionScore":{"type":"number","nullable":true},"lastReviewDate":{"type":"string","nullable":true},"nextReviewDate":{"type":"string","nullable":true},"erpId":{"type":"string","nullable":true},"crmId":{"type":"string","nullable":true},"accountingId":{"type":"string","nullable":true},"lastLoginDate":{"type":"string","nullable":true},"lastInteractionDate":{"type":"string","nullable":true},"totalOrders":{"type":"number","nullable":true},"totalReturns":{"type":"number","nullable":true},"activeSubscriptions":{"type":"number","nullable":true},"metadata":{"type":"object","nullable":true,"additionalProperties":{}},"notes":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"author":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"email":{"type":"string","format":"email"}}},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"visibility":{"type":"string","enum":["internal","public"],"default":"internal"},"content":{"type":"string"}},"required":["content"]}}},"required":["id","name","email","avatar","externalId","stripeCustomerId","linkId","clickId","clickedAt","country","projectId","projectConnectId","createdAt","updatedAt","addressLine1","addressLine2","city","contact","countryCode","state","zip","note","phone","token","vatNumber","website","companyName","tradingName","registrationNumber","isVendor","alternativePhone","fax","contactTitle","contactEmail","contactPhone","billingAddressLine1","billingAddressLine2","billingCity","billingState","billingZip","billingCountryCode","billingEmail","taxId","taxExempt","taxExemptionNumber","currency","preferredPaymentMethod","paymentTerms","bankName","bankAccountName","bankAccountNumber","bankRoutingNumber","bankSwiftCode","bankIban","industry","customerType","customerStatus","customerRating","discountTerms","creditScore","customFields","lastOrderDate","accountManager","shippingAddresses","billingAddresses","warehouseAddresses","billingCurrency","billingCycle","invoiceDeliveryMethod","invoiceFormat","purchaseOrderRequired","autoInvoice","taxExemptionExpiry","taxJurisdiction","taxClassification","taxDocuments","riskRating","insurancePolicy","insuranceExpiry","averagePaymentDays","paymentFrequency","bankAccounts","contractStartDate","contractEndDate","contractRenewalDate","contractStatus","legalStatus","complianceStatus","certifications","licenses","ndaStatus","ndaExpiryDate","customerSegment","accountTier","leadSource","marketingCampaigns","preferredLanguage","communicationPreferences","subscriptionStatus","loyaltyPoints","referralSource","referralCode","satisfactionScore","lastReviewDate","nextReviewDate","erpId","crmId","accountingId","lastLoginDate","lastInteractionDate","totalOrders","totalReturns","activeSubscriptions","metadata","notes"]}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/customers/{id}":{"get":{"operationId":"getCustomer","x-speakeasy-name-override":"get","summary":"Retrieve a customer","description":"Retrieve a customer by ID for the authenticated workspace.","tags":["Customers"],"security":[{"token":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true},{"in":"query","name":"includeExpandedFields","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The customer object.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"avatar":{"type":"string","nullable":true},"externalId":{"type":"string","nullable":true},"stripeCustomerId":{"type":"string","nullable":true},"linkId":{"type":"string","nullable":true},"clickId":{"type":"string","nullable":true},"clickedAt":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"projectId":{"type":"string"},"projectConnectId":{"type":"string","nullable":true},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"addressLine1":{"type":"string","nullable":true},"addressLine2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"contact":{"type":"string","nullable":true},"countryCode":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"zip":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"vatNumber":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"companyName":{"type":"string","nullable":true},"tradingName":{"type":"string","nullable":true},"registrationNumber":{"type":"string","nullable":true},"isVendor":{"type":"boolean"},"alternativePhone":{"type":"string","nullable":true},"fax":{"type":"string","nullable":true},"contactTitle":{"type":"string","nullable":true},"contactEmail":{"type":"string","nullable":true},"contactPhone":{"type":"string","nullable":true},"billingAddressLine1":{"type":"string","nullable":true},"billingAddressLine2":{"type":"string","nullable":true},"billingCity":{"type":"string","nullable":true},"billingState":{"type":"string","nullable":true},"billingZip":{"type":"string","nullable":true},"billingCountryCode":{"type":"string","nullable":true},"billingEmail":{"type":"string","nullable":true},"taxId":{"type":"string","nullable":true},"taxExempt":{"type":"boolean"},"taxExemptionNumber":{"type":"string","nullable":true},"currency":{"type":"string","nullable":true},"preferredPaymentMethod":{"type":"string","nullable":true},"paymentTerms":{"type":"string","nullable":true},"creditLimit":{"nullable":true},"bankName":{"type":"string","nullable":true},"bankAccountName":{"type":"string","nullable":true},"bankAccountNumber":{"type":"string","nullable":true},"bankRoutingNumber":{"type":"string","nullable":true},"bankSwiftCode":{"type":"string","nullable":true},"bankIban":{"type":"string","nullable":true},"industry":{"type":"string","nullable":true},"customerType":{"type":"string","nullable":true},"customerStatus":{"type":"string","nullable":true},"customerRating":{"type":"number","nullable":true},"discountTerms":{"type":"string","nullable":true},"latePaymentPenalty":{"nullable":true},"creditScore":{"type":"number","nullable":true},"customFields":{"type":"object","nullable":true,"additionalProperties":{}},"lastOrderDate":{"type":"string","nullable":true},"accountManager":{"type":"string","nullable":true},"shippingAddresses":{"type":"string","nullable":true},"billingAddresses":{"type":"string","nullable":true},"warehouseAddresses":{"type":"string","nullable":true},"billingCurrency":{"type":"string","nullable":true},"billingCycle":{"type":"string","nullable":true},"invoiceDeliveryMethod":{"type":"string","nullable":true},"invoiceFormat":{"type":"string","nullable":true},"purchaseOrderRequired":{"type":"boolean"},"autoInvoice":{"type":"boolean"},"taxExemptionExpiry":{"type":"string","nullable":true},"taxJurisdiction":{"type":"string","nullable":true},"taxClassification":{"type":"string","nullable":true},"withholdingTaxRate":{"nullable":true},"taxDocuments":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"type":{"type":"string"},"jurisdiction":{"type":"string"},"issuedBy":{"type":"string"},"validFrom":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"validTo":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"url":{"type":"string","format":"uri"}}}},"availableCredit":{"nullable":true},"riskRating":{"type":"string","nullable":true},"insurancePolicy":{"type":"string","nullable":true},"insuranceExpiry":{"type":"string","nullable":true},"insuranceCoverage":{"nullable":true},"earlyPaymentDiscount":{"nullable":true},"minimumOrderValue":{"nullable":true},"maximumOrderValue":{"nullable":true},"averagePaymentDays":{"type":"number","nullable":true},"paymentFrequency":{"type":"string","nullable":true},"bankAccounts":{"type":"array","nullable":true,"items":{"type":"object","properties":{"bankName":{"type":"string"},"holderName":{"type":"string"},"accountNumber":{"type":"string"},"routingNumber":{"type":"string"},"swift":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"type":{"type":"string"},"isPrimary":{"type":"boolean"}}}},"contractStartDate":{"type":"string","nullable":true},"contractEndDate":{"type":"string","nullable":true},"contractRenewalDate":{"type":"string","nullable":true},"contractStatus":{"type":"string","nullable":true},"legalStatus":{"type":"string","nullable":true},"complianceStatus":{"type":"string","nullable":true},"certifications":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"issuer":{"type":"string"},"issuedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"expiresAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"url":{"type":"string","format":"uri"}},"required":["name"]}},"licenses":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"number":{"type":"string"},"issuer":{"type":"string"},"issuedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"expiresAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"url":{"type":"string","format":"uri"}},"required":["name"]}},"ndaStatus":{"type":"boolean"},"ndaExpiryDate":{"type":"string","nullable":true},"customerSegment":{"type":"string","nullable":true},"accountTier":{"type":"string","nullable":true},"leadSource":{"type":"string","nullable":true},"marketingCampaigns":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"source":{"type":"string"},"medium":{"type":"string"},"campaignId":{"type":"string"},"channel":{"type":"string"},"startedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"endedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"budget":{"type":"number","minimum":0},"spend":{"type":"number","minimum":0},"clicks":{"type":"integer","minimum":0},"conversions":{"type":"integer","minimum":0}},"required":["name"]}},"preferredLanguage":{"type":"string","nullable":true},"communicationPreferences":{"type":"object","nullable":true,"properties":{"email":{"type":"object","properties":{"newsletters":{"type":"boolean","default":false},"promotions":{"type":"boolean","default":false},"productUpdates":{"type":"boolean","default":true}}},"phone":{"type":"object","properties":{"sms":{"type":"boolean","default":false},"calls":{"type":"boolean","default":false}}},"channels":{"type":"array","items":{"type":"string"}},"preferredLanguage":{"type":"string"},"preferredTimes":{"type":"array","items":{"type":"string"}}}},"subscriptionStatus":{"type":"string","nullable":true},"loyaltyPoints":{"type":"number","nullable":true},"referralSource":{"type":"string","nullable":true},"referralCode":{"type":"string","nullable":true},"lifetimeValue":{"nullable":true},"acquisitionCost":{"nullable":true},"retentionRate":{"nullable":true},"satisfactionScore":{"type":"number","nullable":true},"lastReviewDate":{"type":"string","nullable":true},"nextReviewDate":{"type":"string","nullable":true},"erpId":{"type":"string","nullable":true},"crmId":{"type":"string","nullable":true},"accountingId":{"type":"string","nullable":true},"lastLoginDate":{"type":"string","nullable":true},"lastInteractionDate":{"type":"string","nullable":true},"totalOrders":{"type":"number","nullable":true},"totalReturns":{"type":"number","nullable":true},"activeSubscriptions":{"type":"number","nullable":true},"metadata":{"type":"object","nullable":true,"additionalProperties":{}},"notes":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"author":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"email":{"type":"string","format":"email"}}},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"visibility":{"type":"string","enum":["internal","public"],"default":"internal"},"content":{"type":"string"}},"required":["content"]}}},"required":["id","name","email","avatar","externalId","stripeCustomerId","linkId","clickId","clickedAt","country","projectId","projectConnectId","createdAt","updatedAt","addressLine1","addressLine2","city","contact","countryCode","state","zip","note","phone","token","vatNumber","website","companyName","tradingName","registrationNumber","isVendor","alternativePhone","fax","contactTitle","contactEmail","contactPhone","billingAddressLine1","billingAddressLine2","billingCity","billingState","billingZip","billingCountryCode","billingEmail","taxId","taxExempt","taxExemptionNumber","currency","preferredPaymentMethod","paymentTerms","bankName","bankAccountName","bankAccountNumber","bankRoutingNumber","bankSwiftCode","bankIban","industry","customerType","customerStatus","customerRating","discountTerms","creditScore","customFields","lastOrderDate","accountManager","shippingAddresses","billingAddresses","warehouseAddresses","billingCurrency","billingCycle","invoiceDeliveryMethod","invoiceFormat","purchaseOrderRequired","autoInvoice","taxExemptionExpiry","taxJurisdiction","taxClassification","taxDocuments","riskRating","insurancePolicy","insuranceExpiry","averagePaymentDays","paymentFrequency","bankAccounts","contractStartDate","contractEndDate","contractRenewalDate","contractStatus","legalStatus","complianceStatus","certifications","licenses","ndaStatus","ndaExpiryDate","customerSegment","accountTier","leadSource","marketingCampaigns","preferredLanguage","communicationPreferences","subscriptionStatus","loyaltyPoints","referralSource","referralCode","satisfactionScore","lastReviewDate","nextReviewDate","erpId","crmId","accountingId","lastLoginDate","lastInteractionDate","totalOrders","totalReturns","activeSubscriptions","metadata","notes"]}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}},"patch":{"operationId":"updateCustomer","x-speakeasy-name-override":"update","x-speakeasy-max-method-params":2,"summary":"Update a customer","description":"Update a customer for the authenticated workspace.","tags":["Customers"],"security":[{"token":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true},{"in":"query","name":"includeExpandedFields","schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email"},"name":{"type":"string"},"avatar":{"type":"string"},"externalId":{"type":"string"}}}}}},"responses":{"200":{"description":"The customer was updated.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"avatar":{"type":"string","nullable":true},"externalId":{"type":"string","nullable":true},"stripeCustomerId":{"type":"string","nullable":true},"linkId":{"type":"string","nullable":true},"clickId":{"type":"string","nullable":true},"clickedAt":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"projectId":{"type":"string"},"projectConnectId":{"type":"string","nullable":true},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"addressLine1":{"type":"string","nullable":true},"addressLine2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"contact":{"type":"string","nullable":true},"countryCode":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"zip":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"vatNumber":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"companyName":{"type":"string","nullable":true},"tradingName":{"type":"string","nullable":true},"registrationNumber":{"type":"string","nullable":true},"isVendor":{"type":"boolean"},"alternativePhone":{"type":"string","nullable":true},"fax":{"type":"string","nullable":true},"contactTitle":{"type":"string","nullable":true},"contactEmail":{"type":"string","nullable":true},"contactPhone":{"type":"string","nullable":true},"billingAddressLine1":{"type":"string","nullable":true},"billingAddressLine2":{"type":"string","nullable":true},"billingCity":{"type":"string","nullable":true},"billingState":{"type":"string","nullable":true},"billingZip":{"type":"string","nullable":true},"billingCountryCode":{"type":"string","nullable":true},"billingEmail":{"type":"string","nullable":true},"taxId":{"type":"string","nullable":true},"taxExempt":{"type":"boolean"},"taxExemptionNumber":{"type":"string","nullable":true},"currency":{"type":"string","nullable":true},"preferredPaymentMethod":{"type":"string","nullable":true},"paymentTerms":{"type":"string","nullable":true},"creditLimit":{"nullable":true},"bankName":{"type":"string","nullable":true},"bankAccountName":{"type":"string","nullable":true},"bankAccountNumber":{"type":"string","nullable":true},"bankRoutingNumber":{"type":"string","nullable":true},"bankSwiftCode":{"type":"string","nullable":true},"bankIban":{"type":"string","nullable":true},"industry":{"type":"string","nullable":true},"customerType":{"type":"string","nullable":true},"customerStatus":{"type":"string","nullable":true},"customerRating":{"type":"number","nullable":true},"discountTerms":{"type":"string","nullable":true},"latePaymentPenalty":{"nullable":true},"creditScore":{"type":"number","nullable":true},"customFields":{"type":"object","nullable":true,"additionalProperties":{}},"lastOrderDate":{"type":"string","nullable":true},"accountManager":{"type":"string","nullable":true},"shippingAddresses":{"type":"string","nullable":true},"billingAddresses":{"type":"string","nullable":true},"warehouseAddresses":{"type":"string","nullable":true},"billingCurrency":{"type":"string","nullable":true},"billingCycle":{"type":"string","nullable":true},"invoiceDeliveryMethod":{"type":"string","nullable":true},"invoiceFormat":{"type":"string","nullable":true},"purchaseOrderRequired":{"type":"boolean"},"autoInvoice":{"type":"boolean"},"taxExemptionExpiry":{"type":"string","nullable":true},"taxJurisdiction":{"type":"string","nullable":true},"taxClassification":{"type":"string","nullable":true},"withholdingTaxRate":{"nullable":true},"taxDocuments":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"type":{"type":"string"},"jurisdiction":{"type":"string"},"issuedBy":{"type":"string"},"validFrom":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"validTo":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"url":{"type":"string","format":"uri"}}}},"availableCredit":{"nullable":true},"riskRating":{"type":"string","nullable":true},"insurancePolicy":{"type":"string","nullable":true},"insuranceExpiry":{"type":"string","nullable":true},"insuranceCoverage":{"nullable":true},"earlyPaymentDiscount":{"nullable":true},"minimumOrderValue":{"nullable":true},"maximumOrderValue":{"nullable":true},"averagePaymentDays":{"type":"number","nullable":true},"paymentFrequency":{"type":"string","nullable":true},"bankAccounts":{"type":"array","nullable":true,"items":{"type":"object","properties":{"bankName":{"type":"string"},"holderName":{"type":"string"},"accountNumber":{"type":"string"},"routingNumber":{"type":"string"},"swift":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"type":{"type":"string"},"isPrimary":{"type":"boolean"}}}},"contractStartDate":{"type":"string","nullable":true},"contractEndDate":{"type":"string","nullable":true},"contractRenewalDate":{"type":"string","nullable":true},"contractStatus":{"type":"string","nullable":true},"legalStatus":{"type":"string","nullable":true},"complianceStatus":{"type":"string","nullable":true},"certifications":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"issuer":{"type":"string"},"issuedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"expiresAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"url":{"type":"string","format":"uri"}},"required":["name"]}},"licenses":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"number":{"type":"string"},"issuer":{"type":"string"},"issuedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"expiresAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"url":{"type":"string","format":"uri"}},"required":["name"]}},"ndaStatus":{"type":"boolean"},"ndaExpiryDate":{"type":"string","nullable":true},"customerSegment":{"type":"string","nullable":true},"accountTier":{"type":"string","nullable":true},"leadSource":{"type":"string","nullable":true},"marketingCampaigns":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"source":{"type":"string"},"medium":{"type":"string"},"campaignId":{"type":"string"},"channel":{"type":"string"},"startedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"endedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"budget":{"type":"number","minimum":0},"spend":{"type":"number","minimum":0},"clicks":{"type":"integer","minimum":0},"conversions":{"type":"integer","minimum":0}},"required":["name"]}},"preferredLanguage":{"type":"string","nullable":true},"communicationPreferences":{"type":"object","nullable":true,"properties":{"email":{"type":"object","properties":{"newsletters":{"type":"boolean","default":false},"promotions":{"type":"boolean","default":false},"productUpdates":{"type":"boolean","default":true}}},"phone":{"type":"object","properties":{"sms":{"type":"boolean","default":false},"calls":{"type":"boolean","default":false}}},"channels":{"type":"array","items":{"type":"string"}},"preferredLanguage":{"type":"string"},"preferredTimes":{"type":"array","items":{"type":"string"}}}},"subscriptionStatus":{"type":"string","nullable":true},"loyaltyPoints":{"type":"number","nullable":true},"referralSource":{"type":"string","nullable":true},"referralCode":{"type":"string","nullable":true},"lifetimeValue":{"nullable":true},"acquisitionCost":{"nullable":true},"retentionRate":{"nullable":true},"satisfactionScore":{"type":"number","nullable":true},"lastReviewDate":{"type":"string","nullable":true},"nextReviewDate":{"type":"string","nullable":true},"erpId":{"type":"string","nullable":true},"crmId":{"type":"string","nullable":true},"accountingId":{"type":"string","nullable":true},"lastLoginDate":{"type":"string","nullable":true},"lastInteractionDate":{"type":"string","nullable":true},"totalOrders":{"type":"number","nullable":true},"totalReturns":{"type":"number","nullable":true},"activeSubscriptions":{"type":"number","nullable":true},"metadata":{"type":"object","nullable":true,"additionalProperties":{}},"notes":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"author":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"email":{"type":"string","format":"email"}}},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"visibility":{"type":"string","enum":["internal","public"],"default":"internal"},"content":{"type":"string"}},"required":["content"]}}},"required":["id","name","email","avatar","externalId","stripeCustomerId","linkId","clickId","clickedAt","country","projectId","projectConnectId","createdAt","updatedAt","addressLine1","addressLine2","city","contact","countryCode","state","zip","note","phone","token","vatNumber","website","companyName","tradingName","registrationNumber","isVendor","alternativePhone","fax","contactTitle","contactEmail","contactPhone","billingAddressLine1","billingAddressLine2","billingCity","billingState","billingZip","billingCountryCode","billingEmail","taxId","taxExempt","taxExemptionNumber","currency","preferredPaymentMethod","paymentTerms","bankName","bankAccountName","bankAccountNumber","bankRoutingNumber","bankSwiftCode","bankIban","industry","customerType","customerStatus","customerRating","discountTerms","creditScore","customFields","lastOrderDate","accountManager","shippingAddresses","billingAddresses","warehouseAddresses","billingCurrency","billingCycle","invoiceDeliveryMethod","invoiceFormat","purchaseOrderRequired","autoInvoice","taxExemptionExpiry","taxJurisdiction","taxClassification","taxDocuments","riskRating","insurancePolicy","insuranceExpiry","averagePaymentDays","paymentFrequency","bankAccounts","contractStartDate","contractEndDate","contractRenewalDate","contractStatus","legalStatus","complianceStatus","certifications","licenses","ndaStatus","ndaExpiryDate","customerSegment","accountTier","leadSource","marketingCampaigns","preferredLanguage","communicationPreferences","subscriptionStatus","loyaltyPoints","referralSource","referralCode","satisfactionScore","lastReviewDate","nextReviewDate","erpId","crmId","accountingId","lastLoginDate","lastInteractionDate","totalOrders","totalReturns","activeSubscriptions","metadata","notes"]}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"deleteCustomer","x-speakeasy-name-override":"delete","x-speakeasy-max-method-params":1,"summary":"Delete a customer","description":"Delete a customer from a workspace.","tags":["Customers"],"security":[{"token":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"The customer was deleted.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/workspaces/{idOrSlug}":{"get":{"operationId":"getWorkspace","x-speakeasy-name-override":"get","summary":"Retrieve a workspace","description":"Retrieve a workspace for the authenticated user.","tags":["Workspaces"],"security":[{"token":[]}],"parameters":[{"in":"path","name":"idOrSlug","description":"The ID or slug of the workspace.","schema":{"type":"string","description":"The ID or slug of the workspace."},"required":true}],"responses":{"200":{"description":"The retrieved workspace","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSchema"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}},"patch":{"operationId":"updateWorkspace","x-speakeasy-name-override":"update","x-speakeasy-max-method-params":2,"summary":"Update a workspace","description":"Update a workspace by ID or slug.","tags":["Workspaces"],"security":[{"token":[]}],"parameters":[{"in":"path","name":"idOrSlug","description":"The ID or slug of the workspace to update.","schema":{"type":"string","description":"The ID or slug of the workspace to update."},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32},"slug":{"type":"string","minLength":3,"maxLength":48},"logo":{"type":"string"},"adminRole":{"type":"string","enum":["SoftwareEngineer","ProductManager","CustomerSuccess","Marketing","Sales","Support","Founder","CTO","CEO","CFO","COO","CMO","Other"]},"organizationSize":{"type":"string","enum":["OneToFive","SixToTwentyFive","TwentySixToOneHundred","OneHundredOneToFiveHundred","FiveHundredToOneThousand","OneThousandToFiveThousand","FiveThousandPlus"]},"reason":{"type":"string"}}}}}},"responses":{"200":{"description":"The updated workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSchema"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/tokens/embed":{"post":{"operationId":"createEmbedToken","x-speakeasy-name-override":"create","summary":"Create a new embed token","description":"Create a new embed token for the referral link.","tags":["Embed Tokens"],"security":[{"token":[]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"linkId":{"type":"string","minLength":1}},"required":["linkId"]}}}},"responses":{"201":{"description":"The created public embed token.","content":{"application/json":{"schema":{"type":"object","properties":{"publicToken":{"type":"string"},"expires":{"type":"string"}},"required":["publicToken","expires"]}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/qr":{"get":{"operationId":"getQRCode","x-speakeasy-name-override":"get","summary":"Retrieve a QR code","description":"Retrieve a QR code for a link.","tags":["QR Codes"],"parameters":[{"in":"query","name":"url","description":"The URL to generate a QR code for.","schema":{"type":"string","description":"The URL to generate a QR code for."},"required":true},{"in":"query","name":"logo","description":"The logo to include in the QR code. Can only be used with a paid plan on Think Thank.","schema":{"type":"string","description":"The logo to include in the QR code. Can only be used with a paid plan on Think Thank."}},{"in":"query","name":"size","description":"The size of the QR code in pixels. Defaults to `600` if not provided.","schema":{"type":"number","default":600,"description":"The size of the QR code in pixels. Defaults to `600` if not provided."}},{"in":"query","name":"level","description":"The level of error correction to use for the QR code. Defaults to `L` if not provided.","schema":{"type":"string","enum":["L","M","Q","H"],"default":"L","description":"The level of error correction to use for the QR code. Defaults to `L` if not provided."}},{"in":"query","name":"fgColor","description":"The foreground color of the QR code in hex format. Defaults to `#000000` if not provided.","schema":{"type":"string","default":"#000000","description":"The foreground color of the QR code in hex format. Defaults to `#000000` if not provided."}},{"in":"query","name":"bgColor","description":"The background color of the QR code in hex format. Defaults to `#ffffff` if not provided.","schema":{"type":"string","default":"#FFFFFF","description":"The background color of the QR code in hex format. Defaults to `#ffffff` if not provided."}},{"in":"query","name":"hideLogo","description":"Whether to hide the logo in the QR code. Can only be used with a paid plan on Think Thank.","schema":{"type":"boolean","default":"false","description":"Whether to hide the logo in the QR code. Can only be used with a paid plan on Think Thank."}},{"in":"query","name":"margin","description":"The size of the margin around the QR code. Defaults to 2 if not provided.","schema":{"type":"number","default":2,"description":"The size of the margin around the QR code. Defaults to 2 if not provided."}},{"in":"query","name":"includeMargin","description":"DEPRECATED: Margin is included by default. Use the `margin` prop to customize the margin size.","schema":{"type":"boolean","default":"true","description":"DEPRECATED: Margin is included by default. Use the `margin` prop to customize the margin size.","deprecated":true}}],"responses":{"200":{"description":"The QR code","content":{"image/png":{"schema":{"type":"string"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/metatags":{"get":{"operationId":"getMetatags","x-speakeasy-name-override":"get","summary":"Retrieve the metatags for a URL","description":"Retrieve the metatags for a URL.","tags":["Metatags"],"parameters":[{"in":"query","name":"url","description":"The URL to retrieve metatags for.","schema":{"type":"string","example":"https://paperless.oppulence.app/","description":"The URL to retrieve metatags for."},"required":true}],"responses":{"200":{"description":"The retrieved metatags","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","nullable":true,"description":"The meta title tag for the URL.","example":"Paperless — Invoicing & Collections for Service SMBs"},"description":{"type":"string","nullable":true,"description":"The meta description tag for the URL.","example":"Service businesses lose cash flow to slow approvals, manual chasing, and poor payer UX. AR Copilot is an AR-first invoicing platform with milestones/deposits, collaborative approvals, and workflow-driven collections that shortens DSO and reduces admin work."},"image":{"type":"string","nullable":true,"description":"The OpenGraph image for the URL.","example":"https://assets.solomon-ai.app/thumbnail.ppg"}},"required":["title","description","image"]}}}}}}}},"components":{"securitySchemes":{"token":{"type":"http","description":"Bearer token authentication. Include your API key in the Authorization header prefixed with 'Bearer '","scheme":"bearer","bearerFormat":"JWT","x-speakeasy-example":"PLATFORM_API_KEY"},"apiKey":{"type":"apiKey","description":"API key authentication. Can be used as an alternative to Bearer token","name":"X-API-Key","in":"header"},"oauth2":{"type":"oauth2","description":"OAuth 2.0 authentication for third-party integrations","flows":{"authorizationCode":{"authorizationUrl":"https://oppulence.app/oauth/authorize","tokenUrl":"https://oppulence.app/oauth/token","refreshUrl":"https://oppulence.app/oauth/refresh","scopes":{"read:invoices":"Read invoice data","write:invoices":"Create and update invoices","read:customers":"Read customer data","write:customers":"Create and update customers","read:payments":"Read payment data","write:payments":"Process payments","read:analytics":"Access analytics data","admin":"Full administrative access"}}}}},"examples":{"InvoiceExample":{"value":{"id":"inv_1234567890","status":"pending","amount":1500,"currency":"USD","customerId":"cus_abc123","dueDate":"2024-12-31","items":[{"description":"Consulting services","quantity":10,"unitPrice":150,"total":1500}]}},"ErrorExample":{"value":{"error":{"code":"RESOURCE_NOT_FOUND","message":"The requested invoice could not be found","details":{"invoiceId":"inv_1234567890"}}}}},"schemas":{"LinkSchema":{"type":"object","properties":{"id":{"type":"string"},"domain":{"type":"string"},"key":{"type":"string"},"url":{"type":"string"},"shortLink":{"type":"string"},"archived":{"type":"boolean"},"expiresAt":{"type":"string","nullable":true},"expiredUrl":{"type":"string","nullable":true},"password":{"type":"string","nullable":true},"trackConversion":{"type":"boolean"},"proxy":{"type":"boolean"},"title":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"image":{"type":"string","nullable":true},"video":{"type":"string","nullable":true},"utm_source":{"type":"string","nullable":true},"utm_medium":{"type":"string","nullable":true},"utm_campaign":{"type":"string","nullable":true},"utm_term":{"type":"string","nullable":true},"utm_content":{"type":"string","nullable":true},"rewrite":{"type":"boolean"},"doIndex":{"type":"boolean"},"ios":{"type":"string","nullable":true},"android":{"type":"string","nullable":true},"geo":{"allOf":[{"$ref":"#/components/schemas/JsonValueSchema"}],"nullable":true},"userId":{"type":"string","nullable":true},"projectId":{"type":"string","nullable":true},"externalId":{"type":"string","nullable":true},"tenantId":{"type":"string","nullable":true},"publicStats":{"type":"boolean"},"clicks":{"type":"number"},"lastClicked":{"type":"string","nullable":true},"leads":{"type":"number"},"sales":{"type":"number"},"saleAmount":{"type":"number"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"comments":{"type":"string","nullable":true},"programId":{"type":"string","nullable":true}},"required":["id","domain","key","url","shortLink","archived","expiresAt","expiredUrl","password","trackConversion","proxy","title","description","image","video","utm_source","utm_medium","utm_campaign","utm_term","utm_content","rewrite","doIndex","ios","android","geo","userId","projectId","externalId","tenantId","publicStats","clicks","lastClicked","leads","sales","saleAmount","createdAt","updatedAt","comments","programId"]},"WorkspaceSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the workspace."},"name":{"type":"string","description":"The name of the workspace."},"slug":{"type":"string","description":"The slug of the workspace."},"logo":{"type":"string","nullable":true,"default":null,"description":"The logo of the workspace."},"inviteCode":{"type":"string","nullable":true,"description":"The invite code of the workspace."},"plan":{"type":"string","enum":["free","pro","business","business plus","business extra","business max","enterprise"],"description":"The plan of the workspace."},"stripeId":{"type":"string","nullable":true,"description":"The Stripe ID of the workspace."},"billingCycleStart":{"type":"number","description":"The date and time when the billing cycle starts for the workspace."},"paymentFailedAt":{"type":"string","nullable":true,"description":"The date and time when the payment failed for the workspace."},"stripeConnectId":{"type":"string","nullable":true,"description":"The Stripe Connect ID of the workspace."},"payoutMethodId":{"type":"string","nullable":true,"description":"[BETA – Paperless Partners]: The ID of the payment method for partner payouts."},"usage":{"type":"number","description":"The usage of the workspace."},"usageLimit":{"type":"number","description":"The usage limit of the workspace."},"linksUsage":{"type":"number","description":"The links usage of the workspace."},"linksLimit":{"type":"number","description":"The links limit of the workspace."},"salesUsage":{"type":"number","description":"The dollar amount of tracked revenue in the current billing cycle (in cents)."},"salesLimit":{"type":"number","description":"The limit of tracked revenue in the current billing cycle (in cents)."},"domainsLimit":{"type":"number","description":"The domains limit of the workspace."},"tagsLimit":{"type":"number","description":"The tags limit of the workspace."},"usersLimit":{"type":"number","description":"The users limit of the workspace."},"aiUsage":{"type":"number","description":"The AI usage of the workspace."},"aiLimit":{"type":"number","description":"The AI limit of the workspace."},"adminRole":{"type":"string","enum":["SoftwareEngineer","ProductManager","CustomerSuccess","Marketing","Sales","Support","Founder","CTO","CEO","CFO","COO","CMO","Other"],"description":"The admin role of the workspace."},"organizationSize":{"type":"string","enum":["OneToFive","SixToTwentyFive","TwentySixToOneHundred","OneHundredOneToFiveHundred","FiveHundredToOneThousand","OneThousandToFiveThousand","FiveThousandPlus"],"description":"The organization size of the workspace."},"reason":{"type":"string","description":"The reason for creating the workspace."},"conversionEnabled":{"type":"boolean","description":"Whether the workspace has conversion tracking enabled (d.to/conversions)."},"dotLinkClaimed":{"type":"boolean","description":"Whether the workspace has claimed a free .link domain. (opp.link/free)"},"partnersEnabled":{"type":"boolean","description":"Whether the workspace has Paperless Partners enabled."},"createdAt":{"type":"string","description":"The date and time when the workspace was created."},"users":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["owner","member"],"description":"The role of the authenticated user in the workspace."}},"required":["role"]},"description":"The role of the authenticated user in the workspace."},"domains":{"type":"array","items":{"type":"object","properties":{"slug":{"type":"string","description":"The domain name.","example":"acme.com"},"primary":{"type":"boolean","default":false,"description":"Whether the domain is the primary domain for the workspace."},"verified":{"type":"boolean","default":false,"description":"Whether the domain is verified."}},"required":["slug","primary","verified"]},"description":"The domains of the workspace."},"flags":{"type":"object","additionalProperties":{"type":"boolean"},"description":"The feature flags of the workspace, indicating which features are enabled."}},"required":["id","name","slug","logo","inviteCode","plan","stripeId","billingCycleStart","paymentFailedAt","stripeConnectId","payoutMethodId","usage","usageLimit","linksUsage","linksLimit","salesUsage","salesLimit","domainsLimit","tagsLimit","usersLimit","aiUsage","aiLimit","conversionEnabled","dotLinkClaimed","partnersEnabled","createdAt","users","domains"],"title":"Workspace"},"TagSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the tag."},"name":{"type":"string","description":"The name of the tag."},"color":{"type":"string","enum":["red","yellow","green","blue","purple","pink","brown"],"description":"The color of the tag."}},"required":["id","name","color"],"title":"Tag"},"DomainSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the domain."},"slug":{"type":"string","description":"The domain name.","example":"acme.com"},"verified":{"type":"boolean","default":false,"description":"Whether the domain is verified."},"primary":{"type":"boolean","default":false,"description":"Whether the domain is the primary domain for the workspace."},"archived":{"type":"boolean","description":"Whether the domain is archived.","default":false},"placeholder":{"type":"string","nullable":true,"description":"Provide context to your teammates in the link creation modal by showing them an example of a link to be shortened.","example":"https://paperless.oppulence.app/help/article/what-is-dub"},"expiredUrl":{"type":"string","nullable":true,"description":"The URL to redirect to when a link under this domain has expired.","example":"https://acme.com/expired"},"notFoundUrl":{"type":"string","nullable":true,"description":"The URL to redirect to when a link under this domain doesn't exist.","example":"https://acme.com/not-found"},"logo":{"type":"string","nullable":true,"description":"The logo of the domain."},"createdAt":{"type":"string","description":"The date the domain was created."},"updatedAt":{"type":"string","description":"The date the domain was last updated."},"registeredDomain":{"type":"object","nullable":true,"properties":{"id":{"type":"string","description":"The ID of the registered domain record."},"createdAt":{"type":"string","description":"The date the domain was created."},"expiresAt":{"type":"string","description":"The date the domain expires."}},"required":["id","createdAt","expiresAt"],"description":"The registered domain record."}},"required":["id","slug","verified","primary","archived","placeholder","expiredUrl","notFoundUrl","logo","createdAt","updatedAt","registeredDomain"]},"WebhookEvent":{"anyOf":[{"$ref":"#/components/schemas/LinkWebhookEvent"},{"$ref":"#/components/schemas/LinkClickedEvent"},{"$ref":"#/components/schemas/LeadCreatedEvent"},{"$ref":"#/components/schemas/SaleCreatedEvent"}],"description":"Webhook event schema","x-speakeasy-include":true},"LinkErrorSchema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"]},"JsonValueSchema":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JsonValueSchema"}},{"type":"array","items":{"$ref":"#/components/schemas/JsonValueSchema"}}]},"countryCode":{"type":"string","enum":["AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IL","IT","JM","JP","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MK","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","SH","KN","LC","PM","VC","WS","SM","ST","SA","SN","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","AX","BQ","CW","GG","IM","JE","ME","BL","MF","RS","SX","SS","XK"],"description":"The country to retrieve analytics for."},"regionCode":{"type":"string","description":"The ISO 3166-2 region code to retrieve analytics for."},"continentCode":{"type":"string","enum":["AF","AN","AS","EU","NA","OC","SA"],"description":"The continent to retrieve analytics for."},"AnalyticsCount":{"type":"object","properties":{"clicks":{"type":"number","description":"The total number of clicks","default":0},"leads":{"type":"number","description":"The total number of leads","default":0},"sales":{"type":"number","description":"The total number of sales","default":0},"saleAmount":{"type":"number","description":"The total amount of sales, in cents","default":0}},"required":["clicks","leads","sales","saleAmount"],"title":"AnalyticsCount"},"AnalyticsTimeseries":{"type":"object","properties":{"start":{"type":"string","description":"The starting timestamp of the interval"},"clicks":{"type":"number","description":"The number of clicks in the interval","default":0},"leads":{"type":"number","description":"The number of leads in the interval","default":0},"sales":{"type":"number","description":"The number of sales in the interval","default":0},"saleAmount":{"type":"number","description":"The total amount of sales in the interval, in cents","default":0}},"required":["start","clicks","leads","sales","saleAmount"]},"AnalyticsContinents":{"type":"object","properties":{"continent":{"type":"string","enum":["AF","AN","AS","EU","NA","OC","SA"],"description":"The 2-letter ISO 3166-1 code representing the continent associated with the location of the user."},"clicks":{"type":"number","description":"The number of clicks from this continent","default":0},"leads":{"type":"number","description":"The number of leads from this continent","default":0},"sales":{"type":"number","description":"The number of sales from this continent","default":0},"saleAmount":{"type":"number","description":"The total amount of sales from this continent, in cents","default":0}},"required":["continent","clicks","leads","sales","saleAmount"]},"AnalyticsCountries":{"type":"object","properties":{"country":{"type":"string","enum":["AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IL","IT","JM","JP","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MK","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","SH","KN","LC","PM","VC","WS","SM","ST","SA","SN","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","AX","BQ","CW","GG","IM","JE","ME","BL","MF","RS","SX","SS","XK"],"description":"The 2-letter ISO 3166-1 country code for the country associated with the location of the user. Learn more: https://d.to/geo"},"city":{"type":"string","enum":["*"],"default":"*"},"clicks":{"type":"number","description":"The number of clicks from this country","default":0},"leads":{"type":"number","description":"The number of leads from this country","default":0},"sales":{"type":"number","description":"The number of sales from this country","default":0},"saleAmount":{"type":"number","description":"The total amount of sales from this country, in cents","default":0}},"required":["country","city","clicks","leads","sales","saleAmount"]},"AnalyticsCities":{"type":"object","properties":{"city":{"type":"string","description":"The name of the city"},"country":{"type":"string","enum":["AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IL","IT","JM","JP","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MK","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","SH","KN","LC","PM","VC","WS","SM","ST","SA","SN","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","AX","BQ","CW","GG","IM","JE","ME","BL","MF","RS","SX","SS","XK"],"description":"The 2-letter country code of the city: https://d.to/geo"},"clicks":{"type":"number","description":"The number of clicks from this city","default":0},"leads":{"type":"number","description":"The number of leads from this city","default":0},"sales":{"type":"number","description":"The number of sales from this city","default":0},"saleAmount":{"type":"number","description":"The total amount of sales from this city, in cents","default":0}},"required":["city","country","clicks","leads","sales","saleAmount"]},"AnalyticsDevices":{"type":"object","properties":{"device":{"type":"string","description":"The name of the device"},"clicks":{"type":"number","description":"The number of clicks from this device","default":0},"leads":{"type":"number","description":"The number of leads from this device","default":0},"sales":{"type":"number","description":"The number of sales from this device","default":0},"saleAmount":{"type":"number","description":"The total amount of sales from this device, in cents","default":0}},"required":["device","clicks","leads","sales","saleAmount"]},"AnalyticsBrowsers":{"type":"object","properties":{"browser":{"type":"string","description":"The name of the browser"},"clicks":{"type":"number","description":"The number of clicks from this browser","default":0},"leads":{"type":"number","description":"The number of leads from this browser","default":0},"sales":{"type":"number","description":"The number of sales from this browser","default":0},"saleAmount":{"type":"number","description":"The total amount of sales from this browser, in cents","default":0}},"required":["browser","clicks","leads","sales","saleAmount"]},"AnalyticsOS":{"type":"object","properties":{"os":{"type":"string","description":"The name of the OS"},"clicks":{"type":"number","description":"The number of clicks from this OS","default":0},"leads":{"type":"number","description":"The number of leads from this OS","default":0},"sales":{"type":"number","description":"The number of sales from this OS","default":0},"saleAmount":{"type":"number","description":"The total amount of sales from this OS, in cents","default":0}},"required":["os","clicks","leads","sales","saleAmount"]},"AnalyticsTriggers":{"type":"object","properties":{"trigger":{"type":"string","enum":["qr","link"],"description":"The type of trigger method: link click or QR scan"},"clicks":{"type":"number","description":"The number of clicks from this trigger method","default":0},"leads":{"type":"number","description":"The number of leads from this trigger method","default":0},"sales":{"type":"number","description":"The number of sales from this trigger method","default":0},"saleAmount":{"type":"number","description":"The total amount of sales from this trigger method, in cents","default":0}},"required":["trigger","clicks","leads","sales","saleAmount"]},"AnalyticsReferers":{"type":"object","properties":{"referer":{"type":"string","description":"The name of the referer. If unknown, this will be `(direct)`"},"clicks":{"type":"number","description":"The number of clicks from this referer","default":0},"leads":{"type":"number","description":"The number of leads from this referer","default":0},"sales":{"type":"number","description":"The number of sales from this referer","default":0},"saleAmount":{"type":"number","description":"The total amount of sales from this referer, in cents","default":0}},"required":["referer","clicks","leads","sales","saleAmount"]},"AnalyticsRefererUrls":{"type":"object","properties":{"refererUrl":{"type":"string","description":"The full URL of the referer. If unknown, this will be `(direct)`"},"clicks":{"type":"number","description":"The number of clicks from this referer to this URL","default":0},"leads":{"type":"number","description":"The number of leads from this referer to this URL","default":0},"sales":{"type":"number","description":"The number of sales from this referer to this URL","default":0},"saleAmount":{"type":"number","description":"The total amount of sales from this referer to this URL, in cents","default":0}},"required":["refererUrl","clicks","leads","sales","saleAmount"]},"AnalyticsTopLinks":{"type":"object","properties":{"link":{"type":"string","description":"The unique ID of the short link","deprecated":true},"id":{"type":"string","description":"The unique ID of the short link"},"domain":{"type":"string","description":"The domain of the short link"},"key":{"type":"string","description":"The key of the short link"},"shortLink":{"type":"string","description":"The short link URL"},"url":{"type":"string","description":"The destination URL of the short link"},"createdAt":{"type":"string","description":"The creation timestamp of the short link"},"clicks":{"type":"number","description":"The number of clicks from this link","default":0},"leads":{"type":"number","description":"The number of leads from this link","default":0},"sales":{"type":"number","description":"The number of sales from this link","default":0},"saleAmount":{"type":"number","description":"The total amount of sales from this link, in cents","default":0}},"required":["link","id","domain","key","shortLink","url","createdAt","clicks","leads","sales","saleAmount"]},"AnalyticsTopUrls":{"type":"object","properties":{"url":{"type":"string","description":"The destination URL"},"clicks":{"type":"number","description":"The number of clicks from this URL","default":0},"leads":{"type":"number","description":"The number of leads from this URL","default":0},"sales":{"type":"number","description":"The number of sales from this URL","default":0},"saleAmount":{"type":"number","description":"The total amount of sales from this URL, in cents","default":0}},"required":["url","clicks","leads","sales","saleAmount"]},"ClickEvent":{"type":"object","properties":{"event":{"type":"string","enum":["click"]},"timestamp":{"type":"string"},"click":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"country":{"type":"string"},"city":{"type":"string"},"region":{"type":"string"},"continent":{"type":"string"},"device":{"type":"string"},"browser":{"type":"string"},"os":{"type":"string"},"referer":{"type":"string"},"refererUrl":{"type":"string"},"qr":{"type":"boolean"},"ip":{"type":"string"}},"required":["id","url","country","city","region","continent","device","browser","os","referer","refererUrl","ip"]},"link":{"type":"object","properties":{"id":{"type":"string"},"domain":{"type":"string"},"key":{"type":"string","minLength":1,"maxLength":100},"url":{"type":"string","format":"uri"},"shortLink":{"type":"string","format":"uri"},"archived":{"type":"boolean"},"expiresAt":{"type":"string","nullable":true},"expiredUrl":{"type":"string","nullable":true,"format":"uri"},"password":{"type":"string","nullable":true,"minLength":6},"trackConversion":{"type":"boolean","default":true},"proxy":{"type":"boolean","default":false},"title":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true,"maxLength":1000},"image":{"type":"string","nullable":true,"format":"uri"},"video":{"type":"string","nullable":true,"format":"uri"},"utm_source":{"type":"string","nullable":true,"maxLength":100},"utm_medium":{"type":"string","nullable":true,"maxLength":100},"utm_campaign":{"type":"string","nullable":true,"maxLength":200},"utm_term":{"type":"string","nullable":true,"maxLength":100},"utm_content":{"type":"string","nullable":true,"maxLength":200},"rewrite":{"type":"boolean"},"doIndex":{"type":"boolean","default":false},"ios":{"type":"string","nullable":true,"format":"uri"},"android":{"type":"string","nullable":true,"format":"uri"},"geo":{"type":"object","nullable":true,"additionalProperties":{"type":"string","format":"uri"}},"userId":{"type":"string","nullable":true},"projectId":{"type":"string","nullable":true},"externalId":{"type":"string","nullable":true},"tenantId":{"type":"string","nullable":true},"publicStats":{"type":"boolean","default":false},"clicks":{"type":"number","minimum":0,"default":0},"lastClicked":{"type":"string","nullable":true},"leads":{"type":"number","minimum":0,"default":0},"sales":{"type":"number","minimum":0,"default":0},"saleAmount":{"type":"number","minimum":0,"default":0},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"comments":{"type":"string","nullable":true},"programId":{"type":"string","nullable":true},"type":{"type":"string","enum":["standard","smart","campaign","qr","bio","redirect"],"default":"standard"},"status":{"type":"string","enum":["active","paused","expired","archived","deleted"],"default":"active"},"maxClicks":{"type":"number","nullable":true,"minimum":0,"exclusiveMinimum":true},"uniqueClicks":{"type":"number","minimum":0,"default":0},"metadata":{"type":"object","nullable":true,"properties":{"tags":{"type":"array","items":{"type":"string"},"maxItems":10},"category":{"type":"string","maxLength":100},"notes":{"type":"string","maxLength":1000},"customFields":{"type":"object","additionalProperties":{}},"integrations":{"type":"object","additionalProperties":{}}}}},"required":["id","domain","key","url","shortLink","archived","expiresAt","expiredUrl","password","trackConversion","proxy","title","description","image","video","utm_source","utm_medium","utm_campaign","utm_term","utm_content","rewrite","doIndex","ios","android","geo","userId","projectId","externalId","tenantId","publicStats","clicks","lastClicked","leads","sales","saleAmount","createdAt","updatedAt","comments","programId","type","status","maxClicks","uniqueClicks","metadata"]},"click_id":{"type":"string","description":"Deprecated. Use `click.id` instead.","deprecated":true},"link_id":{"type":"string","description":"Deprecated. Use `link.id` instead.","deprecated":true},"domain":{"type":"string","description":"Deprecated. Use `link.domain` instead.","deprecated":true},"key":{"type":"string","description":"Deprecated. Use `link.key` instead.","deprecated":true},"url":{"type":"string","description":"Deprecated. Use `click.url` instead.","deprecated":true},"continent":{"type":"string","description":"Deprecated. Use `click.continent` instead.","deprecated":true},"country":{"type":"string","description":"Deprecated. Use `click.country` instead.","deprecated":true},"city":{"type":"string","description":"Deprecated. Use `click.city` instead.","deprecated":true},"device":{"type":"string","description":"Deprecated. Use `click.device` instead.","deprecated":true},"browser":{"type":"string","description":"Deprecated. Use `click.browser` instead.","deprecated":true},"os":{"type":"string","description":"Deprecated. Use `click.os` instead.","deprecated":true},"qr":{"type":"number","description":"Deprecated. Use `click.qr` instead.","deprecated":true},"ip":{"type":"string","description":"Deprecated. Use `click.ip` instead.","deprecated":true}},"required":["event","click","link","click_id","link_id","domain","key","url","continent","country","city","device","browser","os","qr","ip"]},"LeadEvent":{"type":"object","properties":{"event":{"type":"string","enum":["lead"]},"timestamp":{"type":"string"},"eventId":{"type":"string"},"eventName":{"type":"string"},"click":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"country":{"type":"string"},"city":{"type":"string"},"region":{"type":"string"},"continent":{"type":"string"},"device":{"type":"string"},"browser":{"type":"string"},"os":{"type":"string"},"referer":{"type":"string"},"refererUrl":{"type":"string"},"qr":{"type":"boolean"},"ip":{"type":"string"}},"required":["id","url","country","city","region","continent","device","browser","os","referer","refererUrl","ip"]},"link":{"type":"object","properties":{"id":{"type":"string"},"domain":{"type":"string"},"key":{"type":"string","minLength":1,"maxLength":100},"url":{"type":"string","format":"uri"},"shortLink":{"type":"string","format":"uri"},"archived":{"type":"boolean"},"expiresAt":{"type":"string","nullable":true},"expiredUrl":{"type":"string","nullable":true,"format":"uri"},"password":{"type":"string","nullable":true,"minLength":6},"trackConversion":{"type":"boolean","default":true},"proxy":{"type":"boolean","default":false},"title":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true,"maxLength":1000},"image":{"type":"string","nullable":true,"format":"uri"},"video":{"type":"string","nullable":true,"format":"uri"},"utm_source":{"type":"string","nullable":true,"maxLength":100},"utm_medium":{"type":"string","nullable":true,"maxLength":100},"utm_campaign":{"type":"string","nullable":true,"maxLength":200},"utm_term":{"type":"string","nullable":true,"maxLength":100},"utm_content":{"type":"string","nullable":true,"maxLength":200},"rewrite":{"type":"boolean"},"doIndex":{"type":"boolean","default":false},"ios":{"type":"string","nullable":true,"format":"uri"},"android":{"type":"string","nullable":true,"format":"uri"},"geo":{"type":"object","nullable":true,"additionalProperties":{"type":"string","format":"uri"}},"userId":{"type":"string","nullable":true},"projectId":{"type":"string","nullable":true},"externalId":{"type":"string","nullable":true},"tenantId":{"type":"string","nullable":true},"publicStats":{"type":"boolean","default":false},"clicks":{"type":"number","minimum":0,"default":0},"lastClicked":{"type":"string","nullable":true},"leads":{"type":"number","minimum":0,"default":0},"sales":{"type":"number","minimum":0,"default":0},"saleAmount":{"type":"number","minimum":0,"default":0},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"comments":{"type":"string","nullable":true},"programId":{"type":"string","nullable":true},"type":{"type":"string","enum":["standard","smart","campaign","qr","bio","redirect"],"default":"standard"},"status":{"type":"string","enum":["active","paused","expired","archived","deleted"],"default":"active"},"maxClicks":{"type":"number","nullable":true,"minimum":0,"exclusiveMinimum":true},"uniqueClicks":{"type":"number","minimum":0,"default":0},"metadata":{"type":"object","nullable":true,"properties":{"tags":{"type":"array","items":{"type":"string"},"maxItems":10},"category":{"type":"string","maxLength":100},"notes":{"type":"string","maxLength":1000},"customFields":{"type":"object","additionalProperties":{}},"integrations":{"type":"object","additionalProperties":{}}}}},"required":["id","domain","key","url","shortLink","archived","expiresAt","expiredUrl","password","trackConversion","proxy","title","description","image","video","utm_source","utm_medium","utm_campaign","utm_term","utm_content","rewrite","doIndex","ios","android","geo","userId","projectId","externalId","tenantId","publicStats","clicks","lastClicked","leads","sales","saleAmount","createdAt","updatedAt","comments","programId","type","status","maxClicks","uniqueClicks","metadata"]},"customer":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"avatar":{"type":"string","nullable":true},"externalId":{"type":"string","nullable":true},"stripeCustomerId":{"type":"string","nullable":true},"linkId":{"type":"string","nullable":true},"clickId":{"type":"string","nullable":true},"clickedAt":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"projectId":{"type":"string"},"projectConnectId":{"type":"string","nullable":true},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"addressLine1":{"type":"string","nullable":true},"addressLine2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"contact":{"type":"string","nullable":true},"countryCode":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"zip":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"vatNumber":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"companyName":{"type":"string","nullable":true},"tradingName":{"type":"string","nullable":true},"registrationNumber":{"type":"string","nullable":true},"isVendor":{"type":"boolean"},"alternativePhone":{"type":"string","nullable":true},"fax":{"type":"string","nullable":true},"contactTitle":{"type":"string","nullable":true},"contactEmail":{"type":"string","nullable":true},"contactPhone":{"type":"string","nullable":true},"billingAddressLine1":{"type":"string","nullable":true},"billingAddressLine2":{"type":"string","nullable":true},"billingCity":{"type":"string","nullable":true},"billingState":{"type":"string","nullable":true},"billingZip":{"type":"string","nullable":true},"billingCountryCode":{"type":"string","nullable":true},"billingEmail":{"type":"string","nullable":true},"taxId":{"type":"string","nullable":true},"taxExempt":{"type":"boolean"},"taxExemptionNumber":{"type":"string","nullable":true},"currency":{"type":"string","nullable":true},"preferredPaymentMethod":{"type":"string","nullable":true},"paymentTerms":{"type":"string","nullable":true},"creditLimit":{"nullable":true},"bankName":{"type":"string","nullable":true},"bankAccountName":{"type":"string","nullable":true},"bankAccountNumber":{"type":"string","nullable":true},"bankRoutingNumber":{"type":"string","nullable":true},"bankSwiftCode":{"type":"string","nullable":true},"bankIban":{"type":"string","nullable":true},"industry":{"type":"string","nullable":true},"customerType":{"type":"string","nullable":true},"customerStatus":{"type":"string","nullable":true},"customerRating":{"type":"number","nullable":true},"discountTerms":{"type":"string","nullable":true},"latePaymentPenalty":{"nullable":true},"creditScore":{"type":"number","nullable":true},"customFields":{"type":"object","nullable":true,"additionalProperties":{}},"lastOrderDate":{"type":"string","nullable":true},"accountManager":{"type":"string","nullable":true},"shippingAddresses":{"type":"string","nullable":true},"billingAddresses":{"type":"string","nullable":true},"warehouseAddresses":{"type":"string","nullable":true},"billingCurrency":{"type":"string","nullable":true},"billingCycle":{"type":"string","nullable":true},"invoiceDeliveryMethod":{"type":"string","nullable":true},"invoiceFormat":{"type":"string","nullable":true},"purchaseOrderRequired":{"type":"boolean"},"autoInvoice":{"type":"boolean"},"taxExemptionExpiry":{"type":"string","nullable":true},"taxJurisdiction":{"type":"string","nullable":true},"taxClassification":{"type":"string","nullable":true},"withholdingTaxRate":{"nullable":true},"taxDocuments":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"type":{"type":"string"},"jurisdiction":{"type":"string"},"issuedBy":{"type":"string"},"validFrom":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"validTo":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"url":{"type":"string","format":"uri"}}}},"availableCredit":{"nullable":true},"riskRating":{"type":"string","nullable":true},"insurancePolicy":{"type":"string","nullable":true},"insuranceExpiry":{"type":"string","nullable":true},"insuranceCoverage":{"nullable":true},"earlyPaymentDiscount":{"nullable":true},"minimumOrderValue":{"nullable":true},"maximumOrderValue":{"nullable":true},"averagePaymentDays":{"type":"number","nullable":true},"paymentFrequency":{"type":"string","nullable":true},"bankAccounts":{"type":"array","nullable":true,"items":{"type":"object","properties":{"bankName":{"type":"string"},"holderName":{"type":"string"},"accountNumber":{"type":"string"},"routingNumber":{"type":"string"},"swift":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"type":{"type":"string"},"isPrimary":{"type":"boolean"}}}},"contractStartDate":{"type":"string","nullable":true},"contractEndDate":{"type":"string","nullable":true},"contractRenewalDate":{"type":"string","nullable":true},"contractStatus":{"type":"string","nullable":true},"legalStatus":{"type":"string","nullable":true},"complianceStatus":{"type":"string","nullable":true},"certifications":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"issuer":{"type":"string"},"issuedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"expiresAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"url":{"type":"string","format":"uri"}},"required":["name"]}},"licenses":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"number":{"type":"string"},"issuer":{"type":"string"},"issuedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"expiresAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"url":{"type":"string","format":"uri"}},"required":["name"]}},"ndaStatus":{"type":"boolean"},"ndaExpiryDate":{"type":"string","nullable":true},"customerSegment":{"type":"string","nullable":true},"accountTier":{"type":"string","nullable":true},"leadSource":{"type":"string","nullable":true},"marketingCampaigns":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"source":{"type":"string"},"medium":{"type":"string"},"campaignId":{"type":"string"},"channel":{"type":"string"},"startedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"endedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"budget":{"type":"number","minimum":0},"spend":{"type":"number","minimum":0},"clicks":{"type":"integer","minimum":0},"conversions":{"type":"integer","minimum":0}},"required":["name"]}},"preferredLanguage":{"type":"string","nullable":true},"communicationPreferences":{"type":"object","nullable":true,"properties":{"email":{"type":"object","properties":{"newsletters":{"type":"boolean","default":false},"promotions":{"type":"boolean","default":false},"productUpdates":{"type":"boolean","default":true}}},"phone":{"type":"object","properties":{"sms":{"type":"boolean","default":false},"calls":{"type":"boolean","default":false}}},"channels":{"type":"array","items":{"type":"string"}},"preferredLanguage":{"type":"string"},"preferredTimes":{"type":"array","items":{"type":"string"}}}},"subscriptionStatus":{"type":"string","nullable":true},"loyaltyPoints":{"type":"number","nullable":true},"referralSource":{"type":"string","nullable":true},"referralCode":{"type":"string","nullable":true},"lifetimeValue":{"nullable":true},"acquisitionCost":{"nullable":true},"retentionRate":{"nullable":true},"satisfactionScore":{"type":"number","nullable":true},"lastReviewDate":{"type":"string","nullable":true},"nextReviewDate":{"type":"string","nullable":true},"erpId":{"type":"string","nullable":true},"crmId":{"type":"string","nullable":true},"accountingId":{"type":"string","nullable":true},"lastLoginDate":{"type":"string","nullable":true},"lastInteractionDate":{"type":"string","nullable":true},"totalOrders":{"type":"number","nullable":true},"totalReturns":{"type":"number","nullable":true},"activeSubscriptions":{"type":"number","nullable":true},"metadata":{"type":"object","nullable":true,"additionalProperties":{}},"notes":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"author":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"email":{"type":"string","format":"email"}}},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"visibility":{"type":"string","enum":["internal","public"],"default":"internal"},"content":{"type":"string"}},"required":["content"]}}},"required":["id","name","email","avatar","externalId","stripeCustomerId","linkId","clickId","clickedAt","country","projectId","projectConnectId","createdAt","updatedAt","addressLine1","addressLine2","city","contact","countryCode","state","zip","note","phone","token","vatNumber","website","companyName","tradingName","registrationNumber","isVendor","alternativePhone","fax","contactTitle","contactEmail","contactPhone","billingAddressLine1","billingAddressLine2","billingCity","billingState","billingZip","billingCountryCode","billingEmail","taxId","taxExempt","taxExemptionNumber","currency","preferredPaymentMethod","paymentTerms","bankName","bankAccountName","bankAccountNumber","bankRoutingNumber","bankSwiftCode","bankIban","industry","customerType","customerStatus","customerRating","discountTerms","creditScore","customFields","lastOrderDate","accountManager","shippingAddresses","billingAddresses","warehouseAddresses","billingCurrency","billingCycle","invoiceDeliveryMethod","invoiceFormat","purchaseOrderRequired","autoInvoice","taxExemptionExpiry","taxJurisdiction","taxClassification","taxDocuments","riskRating","insurancePolicy","insuranceExpiry","averagePaymentDays","paymentFrequency","bankAccounts","contractStartDate","contractEndDate","contractRenewalDate","contractStatus","legalStatus","complianceStatus","certifications","licenses","ndaStatus","ndaExpiryDate","customerSegment","accountTier","leadSource","marketingCampaigns","preferredLanguage","communicationPreferences","subscriptionStatus","loyaltyPoints","referralSource","referralCode","satisfactionScore","lastReviewDate","nextReviewDate","erpId","crmId","accountingId","lastLoginDate","lastInteractionDate","totalOrders","totalReturns","activeSubscriptions","metadata","notes"]},"click_id":{"type":"string","description":"Deprecated. Use `click.id` instead.","deprecated":true},"link_id":{"type":"string","description":"Deprecated. Use `link.id` instead.","deprecated":true},"domain":{"type":"string","description":"Deprecated. Use `link.domain` instead.","deprecated":true},"key":{"type":"string","description":"Deprecated. Use `link.key` instead.","deprecated":true},"url":{"type":"string","description":"Deprecated. Use `click.url` instead.","deprecated":true},"continent":{"type":"string","description":"Deprecated. Use `click.continent` instead.","deprecated":true},"country":{"type":"string","description":"Deprecated. Use `click.country` instead.","deprecated":true},"city":{"type":"string","description":"Deprecated. Use `click.city` instead.","deprecated":true},"device":{"type":"string","description":"Deprecated. Use `click.device` instead.","deprecated":true},"browser":{"type":"string","description":"Deprecated. Use `click.browser` instead.","deprecated":true},"os":{"type":"string","description":"Deprecated. Use `click.os` instead.","deprecated":true},"qr":{"type":"number","description":"Deprecated. Use `click.qr` instead.","deprecated":true},"ip":{"type":"string","description":"Deprecated. Use `click.ip` instead.","deprecated":true}},"required":["event","eventId","eventName","click","link","customer","click_id","link_id","domain","key","url","continent","country","city","device","browser","os","qr","ip"]},"SaleEvent":{"type":"object","properties":{"event":{"type":"string","enum":["sale"]},"timestamp":{"type":"string"},"eventId":{"type":"string"},"eventName":{"type":"string"},"link":{"type":"object","properties":{"id":{"type":"string"},"domain":{"type":"string"},"key":{"type":"string","minLength":1,"maxLength":100},"url":{"type":"string","format":"uri"},"shortLink":{"type":"string","format":"uri"},"archived":{"type":"boolean"},"expiresAt":{"type":"string","nullable":true},"expiredUrl":{"type":"string","nullable":true,"format":"uri"},"password":{"type":"string","nullable":true,"minLength":6},"trackConversion":{"type":"boolean","default":true},"proxy":{"type":"boolean","default":false},"title":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true,"maxLength":1000},"image":{"type":"string","nullable":true,"format":"uri"},"video":{"type":"string","nullable":true,"format":"uri"},"utm_source":{"type":"string","nullable":true,"maxLength":100},"utm_medium":{"type":"string","nullable":true,"maxLength":100},"utm_campaign":{"type":"string","nullable":true,"maxLength":200},"utm_term":{"type":"string","nullable":true,"maxLength":100},"utm_content":{"type":"string","nullable":true,"maxLength":200},"rewrite":{"type":"boolean"},"doIndex":{"type":"boolean","default":false},"ios":{"type":"string","nullable":true,"format":"uri"},"android":{"type":"string","nullable":true,"format":"uri"},"geo":{"type":"object","nullable":true,"additionalProperties":{"type":"string","format":"uri"}},"userId":{"type":"string","nullable":true},"projectId":{"type":"string","nullable":true},"externalId":{"type":"string","nullable":true},"tenantId":{"type":"string","nullable":true},"publicStats":{"type":"boolean","default":false},"clicks":{"type":"number","minimum":0,"default":0},"lastClicked":{"type":"string","nullable":true},"leads":{"type":"number","minimum":0,"default":0},"sales":{"type":"number","minimum":0,"default":0},"saleAmount":{"type":"number","minimum":0,"default":0},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"comments":{"type":"string","nullable":true},"programId":{"type":"string","nullable":true},"type":{"type":"string","enum":["standard","smart","campaign","qr","bio","redirect"],"default":"standard"},"status":{"type":"string","enum":["active","paused","expired","archived","deleted"],"default":"active"},"maxClicks":{"type":"number","nullable":true,"minimum":0,"exclusiveMinimum":true},"uniqueClicks":{"type":"number","minimum":0,"default":0},"metadata":{"type":"object","nullable":true,"properties":{"tags":{"type":"array","items":{"type":"string"},"maxItems":10},"category":{"type":"string","maxLength":100},"notes":{"type":"string","maxLength":1000},"customFields":{"type":"object","additionalProperties":{}},"integrations":{"type":"object","additionalProperties":{}}}}},"required":["id","domain","key","url","shortLink","archived","expiresAt","expiredUrl","password","trackConversion","proxy","title","description","image","video","utm_source","utm_medium","utm_campaign","utm_term","utm_content","rewrite","doIndex","ios","android","geo","userId","projectId","externalId","tenantId","publicStats","clicks","lastClicked","leads","sales","saleAmount","createdAt","updatedAt","comments","programId","type","status","maxClicks","uniqueClicks","metadata"]},"click":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"country":{"type":"string"},"city":{"type":"string"},"region":{"type":"string"},"continent":{"type":"string"},"device":{"type":"string"},"browser":{"type":"string"},"os":{"type":"string"},"referer":{"type":"string"},"refererUrl":{"type":"string"},"qr":{"type":"boolean"},"ip":{"type":"string"}},"required":["id","url","country","city","region","continent","device","browser","os","referer","refererUrl","ip"]},"customer":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"avatar":{"type":"string","nullable":true},"externalId":{"type":"string","nullable":true},"stripeCustomerId":{"type":"string","nullable":true},"linkId":{"type":"string","nullable":true},"clickId":{"type":"string","nullable":true},"clickedAt":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"projectId":{"type":"string"},"projectConnectId":{"type":"string","nullable":true},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"addressLine1":{"type":"string","nullable":true},"addressLine2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"contact":{"type":"string","nullable":true},"countryCode":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"zip":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"vatNumber":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"companyName":{"type":"string","nullable":true},"tradingName":{"type":"string","nullable":true},"registrationNumber":{"type":"string","nullable":true},"isVendor":{"type":"boolean"},"alternativePhone":{"type":"string","nullable":true},"fax":{"type":"string","nullable":true},"contactTitle":{"type":"string","nullable":true},"contactEmail":{"type":"string","nullable":true},"contactPhone":{"type":"string","nullable":true},"billingAddressLine1":{"type":"string","nullable":true},"billingAddressLine2":{"type":"string","nullable":true},"billingCity":{"type":"string","nullable":true},"billingState":{"type":"string","nullable":true},"billingZip":{"type":"string","nullable":true},"billingCountryCode":{"type":"string","nullable":true},"billingEmail":{"type":"string","nullable":true},"taxId":{"type":"string","nullable":true},"taxExempt":{"type":"boolean"},"taxExemptionNumber":{"type":"string","nullable":true},"currency":{"type":"string","nullable":true},"preferredPaymentMethod":{"type":"string","nullable":true},"paymentTerms":{"type":"string","nullable":true},"creditLimit":{"nullable":true},"bankName":{"type":"string","nullable":true},"bankAccountName":{"type":"string","nullable":true},"bankAccountNumber":{"type":"string","nullable":true},"bankRoutingNumber":{"type":"string","nullable":true},"bankSwiftCode":{"type":"string","nullable":true},"bankIban":{"type":"string","nullable":true},"industry":{"type":"string","nullable":true},"customerType":{"type":"string","nullable":true},"customerStatus":{"type":"string","nullable":true},"customerRating":{"type":"number","nullable":true},"discountTerms":{"type":"string","nullable":true},"latePaymentPenalty":{"nullable":true},"creditScore":{"type":"number","nullable":true},"customFields":{"type":"object","nullable":true,"additionalProperties":{}},"lastOrderDate":{"type":"string","nullable":true},"accountManager":{"type":"string","nullable":true},"shippingAddresses":{"type":"string","nullable":true},"billingAddresses":{"type":"string","nullable":true},"warehouseAddresses":{"type":"string","nullable":true},"billingCurrency":{"type":"string","nullable":true},"billingCycle":{"type":"string","nullable":true},"invoiceDeliveryMethod":{"type":"string","nullable":true},"invoiceFormat":{"type":"string","nullable":true},"purchaseOrderRequired":{"type":"boolean"},"autoInvoice":{"type":"boolean"},"taxExemptionExpiry":{"type":"string","nullable":true},"taxJurisdiction":{"type":"string","nullable":true},"taxClassification":{"type":"string","nullable":true},"withholdingTaxRate":{"nullable":true},"taxDocuments":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"type":{"type":"string"},"jurisdiction":{"type":"string"},"issuedBy":{"type":"string"},"validFrom":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"validTo":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"url":{"type":"string","format":"uri"}}}},"availableCredit":{"nullable":true},"riskRating":{"type":"string","nullable":true},"insurancePolicy":{"type":"string","nullable":true},"insuranceExpiry":{"type":"string","nullable":true},"insuranceCoverage":{"nullable":true},"earlyPaymentDiscount":{"nullable":true},"minimumOrderValue":{"nullable":true},"maximumOrderValue":{"nullable":true},"averagePaymentDays":{"type":"number","nullable":true},"paymentFrequency":{"type":"string","nullable":true},"bankAccounts":{"type":"array","nullable":true,"items":{"type":"object","properties":{"bankName":{"type":"string"},"holderName":{"type":"string"},"accountNumber":{"type":"string"},"routingNumber":{"type":"string"},"swift":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"type":{"type":"string"},"isPrimary":{"type":"boolean"}}}},"contractStartDate":{"type":"string","nullable":true},"contractEndDate":{"type":"string","nullable":true},"contractRenewalDate":{"type":"string","nullable":true},"contractStatus":{"type":"string","nullable":true},"legalStatus":{"type":"string","nullable":true},"complianceStatus":{"type":"string","nullable":true},"certifications":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"issuer":{"type":"string"},"issuedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"expiresAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"url":{"type":"string","format":"uri"}},"required":["name"]}},"licenses":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"number":{"type":"string"},"issuer":{"type":"string"},"issuedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"expiresAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"url":{"type":"string","format":"uri"}},"required":["name"]}},"ndaStatus":{"type":"boolean"},"ndaExpiryDate":{"type":"string","nullable":true},"customerSegment":{"type":"string","nullable":true},"accountTier":{"type":"string","nullable":true},"leadSource":{"type":"string","nullable":true},"marketingCampaigns":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"source":{"type":"string"},"medium":{"type":"string"},"campaignId":{"type":"string"},"channel":{"type":"string"},"startedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"endedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"budget":{"type":"number","minimum":0},"spend":{"type":"number","minimum":0},"clicks":{"type":"integer","minimum":0},"conversions":{"type":"integer","minimum":0}},"required":["name"]}},"preferredLanguage":{"type":"string","nullable":true},"communicationPreferences":{"type":"object","nullable":true,"properties":{"email":{"type":"object","properties":{"newsletters":{"type":"boolean","default":false},"promotions":{"type":"boolean","default":false},"productUpdates":{"type":"boolean","default":true}}},"phone":{"type":"object","properties":{"sms":{"type":"boolean","default":false},"calls":{"type":"boolean","default":false}}},"channels":{"type":"array","items":{"type":"string"}},"preferredLanguage":{"type":"string"},"preferredTimes":{"type":"array","items":{"type":"string"}}}},"subscriptionStatus":{"type":"string","nullable":true},"loyaltyPoints":{"type":"number","nullable":true},"referralSource":{"type":"string","nullable":true},"referralCode":{"type":"string","nullable":true},"lifetimeValue":{"nullable":true},"acquisitionCost":{"nullable":true},"retentionRate":{"nullable":true},"satisfactionScore":{"type":"number","nullable":true},"lastReviewDate":{"type":"string","nullable":true},"nextReviewDate":{"type":"string","nullable":true},"erpId":{"type":"string","nullable":true},"crmId":{"type":"string","nullable":true},"accountingId":{"type":"string","nullable":true},"lastLoginDate":{"type":"string","nullable":true},"lastInteractionDate":{"type":"string","nullable":true},"totalOrders":{"type":"number","nullable":true},"totalReturns":{"type":"number","nullable":true},"activeSubscriptions":{"type":"number","nullable":true},"metadata":{"type":"object","nullable":true,"additionalProperties":{}},"notes":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"author":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"email":{"type":"string","format":"email"}}},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"visibility":{"type":"string","enum":["internal","public"],"default":"internal"},"content":{"type":"string"}},"required":["content"]}}},"required":["id","name","email","avatar","externalId","stripeCustomerId","linkId","clickId","clickedAt","country","projectId","projectConnectId","createdAt","updatedAt","addressLine1","addressLine2","city","contact","countryCode","state","zip","note","phone","token","vatNumber","website","companyName","tradingName","registrationNumber","isVendor","alternativePhone","fax","contactTitle","contactEmail","contactPhone","billingAddressLine1","billingAddressLine2","billingCity","billingState","billingZip","billingCountryCode","billingEmail","taxId","taxExempt","taxExemptionNumber","currency","preferredPaymentMethod","paymentTerms","bankName","bankAccountName","bankAccountNumber","bankRoutingNumber","bankSwiftCode","bankIban","industry","customerType","customerStatus","customerRating","discountTerms","creditScore","customFields","lastOrderDate","accountManager","shippingAddresses","billingAddresses","warehouseAddresses","billingCurrency","billingCycle","invoiceDeliveryMethod","invoiceFormat","purchaseOrderRequired","autoInvoice","taxExemptionExpiry","taxJurisdiction","taxClassification","taxDocuments","riskRating","insurancePolicy","insuranceExpiry","averagePaymentDays","paymentFrequency","bankAccounts","contractStartDate","contractEndDate","contractRenewalDate","contractStatus","legalStatus","complianceStatus","certifications","licenses","ndaStatus","ndaExpiryDate","customerSegment","accountTier","leadSource","marketingCampaigns","preferredLanguage","communicationPreferences","subscriptionStatus","loyaltyPoints","referralSource","referralCode","satisfactionScore","lastReviewDate","nextReviewDate","erpId","crmId","accountingId","lastLoginDate","lastInteractionDate","totalOrders","totalReturns","activeSubscriptions","metadata","notes"]},"sale":{"type":"object","properties":{"amount":{"type":"integer","minimum":0,"description":"The amount of the sale. Should be passed in cents."},"invoiceId":{"type":"string","nullable":true,"default":null,"description":"The invoice ID of the sale."},"paymentProcessor":{"type":"string","enum":["stripe","shopify","paddle"],"description":"The payment processor via which the sale was made."}},"required":["amount","invoiceId","paymentProcessor"]},"saleAmount":{"type":"number","description":"Deprecated. Use `sale.amount` instead.","deprecated":true},"invoice_id":{"type":"string","description":"Deprecated. Use `sale.invoiceId` instead.","deprecated":true},"payment_processor":{"type":"string","description":"Deprecated. Use `sale.paymentProcessor` instead."},"click_id":{"type":"string","description":"Deprecated. Use `click.id` instead.","deprecated":true},"link_id":{"type":"string","description":"Deprecated. Use `link.id` instead.","deprecated":true},"domain":{"type":"string","description":"Deprecated. Use `link.domain` instead.","deprecated":true},"key":{"type":"string","description":"Deprecated. Use `link.key` instead.","deprecated":true},"url":{"type":"string","description":"Deprecated. Use `click.url` instead.","deprecated":true},"continent":{"type":"string","description":"Deprecated. Use `click.continent` instead.","deprecated":true},"country":{"type":"string","description":"Deprecated. Use `click.country` instead.","deprecated":true},"city":{"type":"string","description":"Deprecated. Use `click.city` instead.","deprecated":true},"device":{"type":"string","description":"Deprecated. Use `click.device` instead.","deprecated":true},"browser":{"type":"string","description":"Deprecated. Use `click.browser` instead.","deprecated":true},"os":{"type":"string","description":"Deprecated. Use `click.os` instead.","deprecated":true},"qr":{"type":"number","description":"Deprecated. Use `click.qr` instead.","deprecated":true},"ip":{"type":"string","description":"Deprecated. Use `click.ip` instead.","deprecated":true}},"required":["event","eventId","eventName","link","click","customer","sale","saleAmount","invoice_id","payment_processor","click_id","link_id","domain","key","url","continent","country","city","device","browser","os","qr","ip"]},"LinkWebhookEvent":{"type":"object","properties":{"id":{"type":"string"},"event":{"anyOf":[{"type":"string","enum":["link.created"]},{"type":"string","enum":["link.updated"]},{"type":"string","enum":["link.deleted"]}]},"createdAt":{"type":"string"},"data":{"type":"object","properties":{"id":{"type":"string"},"domain":{"type":"string"},"key":{"type":"string","minLength":1,"maxLength":100},"url":{"type":"string","format":"uri"},"shortLink":{"type":"string","format":"uri"},"archived":{"type":"boolean"},"expiresAt":{"type":"string","nullable":true},"expiredUrl":{"type":"string","nullable":true,"format":"uri"},"password":{"type":"string","nullable":true,"minLength":6},"trackConversion":{"type":"boolean","default":true},"proxy":{"type":"boolean","default":false},"title":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true,"maxLength":1000},"image":{"type":"string","nullable":true,"format":"uri"},"video":{"type":"string","nullable":true,"format":"uri"},"utm_source":{"type":"string","nullable":true,"maxLength":100},"utm_medium":{"type":"string","nullable":true,"maxLength":100},"utm_campaign":{"type":"string","nullable":true,"maxLength":200},"utm_term":{"type":"string","nullable":true,"maxLength":100},"utm_content":{"type":"string","nullable":true,"maxLength":200},"rewrite":{"type":"boolean"},"doIndex":{"type":"boolean","default":false},"ios":{"type":"string","nullable":true,"format":"uri"},"android":{"type":"string","nullable":true,"format":"uri"},"geo":{"type":"object","nullable":true,"additionalProperties":{"type":"string","format":"uri"}},"userId":{"type":"string","nullable":true},"projectId":{"type":"string","nullable":true},"externalId":{"type":"string","nullable":true},"tenantId":{"type":"string","nullable":true},"publicStats":{"type":"boolean","default":false},"clicks":{"type":"number","minimum":0,"default":0},"lastClicked":{"type":"string","nullable":true},"leads":{"type":"number","minimum":0,"default":0},"sales":{"type":"number","minimum":0,"default":0},"saleAmount":{"type":"number","minimum":0,"default":0},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"comments":{"type":"string","nullable":true},"programId":{"type":"string","nullable":true},"type":{"type":"string","enum":["standard","smart","campaign","qr","bio","redirect"],"default":"standard"},"status":{"type":"string","enum":["active","paused","expired","archived","deleted"],"default":"active"},"maxClicks":{"type":"number","nullable":true,"minimum":0,"exclusiveMinimum":true},"uniqueClicks":{"type":"number","minimum":0,"default":0},"metadata":{"type":"object","nullable":true,"properties":{"tags":{"type":"array","items":{"type":"string"},"maxItems":10},"category":{"type":"string","maxLength":100},"notes":{"type":"string","maxLength":1000},"customFields":{"type":"object","additionalProperties":{}},"integrations":{"type":"object","additionalProperties":{}}}}},"required":["id","domain","key","url","shortLink","archived","expiresAt","expiredUrl","password","trackConversion","proxy","title","description","image","video","utm_source","utm_medium","utm_campaign","utm_term","utm_content","rewrite","doIndex","ios","android","geo","userId","projectId","externalId","tenantId","publicStats","clicks","lastClicked","leads","sales","saleAmount","createdAt","updatedAt","comments","programId","type","status","maxClicks","uniqueClicks","metadata"]}},"required":["id","event","createdAt","data"],"description":"Triggered when a link is created, updated, or deleted."},"LinkClickedEvent":{"type":"object","properties":{"id":{"type":"string"},"event":{"type":"string","enum":["link.clicked"]},"createdAt":{"type":"string"},"data":{"type":"object","properties":{"click":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"country":{"type":"string"},"city":{"type":"string"},"region":{"type":"string"},"continent":{"type":"string"},"device":{"type":"string"},"browser":{"type":"string"},"os":{"type":"string"},"referer":{"type":"string"},"refererUrl":{"type":"string"},"qr":{"type":"boolean"},"ip":{"type":"string"}},"required":["id","url","country","city","region","continent","device","browser","os","referer","refererUrl","ip"]},"link":{"type":"object","properties":{"id":{"type":"string"},"domain":{"type":"string"},"key":{"type":"string","minLength":1,"maxLength":100},"url":{"type":"string","format":"uri"},"shortLink":{"type":"string","format":"uri"},"archived":{"type":"boolean"},"expiresAt":{"type":"string","nullable":true},"expiredUrl":{"type":"string","nullable":true,"format":"uri"},"password":{"type":"string","nullable":true,"minLength":6},"trackConversion":{"type":"boolean","default":true},"proxy":{"type":"boolean","default":false},"title":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true,"maxLength":1000},"image":{"type":"string","nullable":true,"format":"uri"},"video":{"type":"string","nullable":true,"format":"uri"},"utm_source":{"type":"string","nullable":true,"maxLength":100},"utm_medium":{"type":"string","nullable":true,"maxLength":100},"utm_campaign":{"type":"string","nullable":true,"maxLength":200},"utm_term":{"type":"string","nullable":true,"maxLength":100},"utm_content":{"type":"string","nullable":true,"maxLength":200},"rewrite":{"type":"boolean"},"doIndex":{"type":"boolean","default":false},"ios":{"type":"string","nullable":true,"format":"uri"},"android":{"type":"string","nullable":true,"format":"uri"},"geo":{"type":"object","nullable":true,"additionalProperties":{"type":"string","format":"uri"}},"userId":{"type":"string","nullable":true},"projectId":{"type":"string","nullable":true},"externalId":{"type":"string","nullable":true},"tenantId":{"type":"string","nullable":true},"publicStats":{"type":"boolean","default":false},"clicks":{"type":"number","minimum":0,"default":0},"lastClicked":{"type":"string","nullable":true},"leads":{"type":"number","minimum":0,"default":0},"sales":{"type":"number","minimum":0,"default":0},"saleAmount":{"type":"number","minimum":0,"default":0},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"comments":{"type":"string","nullable":true},"programId":{"type":"string","nullable":true},"type":{"type":"string","enum":["standard","smart","campaign","qr","bio","redirect"],"default":"standard"},"status":{"type":"string","enum":["active","paused","expired","archived","deleted"],"default":"active"},"maxClicks":{"type":"number","nullable":true,"minimum":0,"exclusiveMinimum":true},"uniqueClicks":{"type":"number","minimum":0,"default":0},"metadata":{"type":"object","nullable":true,"properties":{"tags":{"type":"array","items":{"type":"string"},"maxItems":10},"category":{"type":"string","maxLength":100},"notes":{"type":"string","maxLength":1000},"customFields":{"type":"object","additionalProperties":{}},"integrations":{"type":"object","additionalProperties":{}}}}},"required":["id","domain","key","url","shortLink","archived","expiresAt","expiredUrl","password","trackConversion","proxy","title","description","image","video","utm_source","utm_medium","utm_campaign","utm_term","utm_content","rewrite","doIndex","ios","android","geo","userId","projectId","externalId","tenantId","publicStats","clicks","lastClicked","leads","sales","saleAmount","createdAt","updatedAt","comments","programId","type","status","maxClicks","uniqueClicks","metadata"]}},"required":["click","link"]}},"required":["id","event","createdAt","data"],"description":"Triggered when a link is clicked."},"LeadCreatedEvent":{"type":"object","properties":{"id":{"type":"string"},"event":{"type":"string","enum":["lead.created"]},"createdAt":{"type":"string"},"data":{"type":"object","properties":{"eventName":{"type":"string"},"customer":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"avatar":{"type":"string","nullable":true},"externalId":{"type":"string","nullable":true},"stripeCustomerId":{"type":"string","nullable":true},"linkId":{"type":"string","nullable":true},"clickId":{"type":"string","nullable":true},"clickedAt":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"projectId":{"type":"string"},"projectConnectId":{"type":"string","nullable":true},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"addressLine1":{"type":"string","nullable":true},"addressLine2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"contact":{"type":"string","nullable":true},"countryCode":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"zip":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"vatNumber":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"companyName":{"type":"string","nullable":true},"tradingName":{"type":"string","nullable":true},"registrationNumber":{"type":"string","nullable":true},"isVendor":{"type":"boolean"},"alternativePhone":{"type":"string","nullable":true},"fax":{"type":"string","nullable":true},"contactTitle":{"type":"string","nullable":true},"contactEmail":{"type":"string","nullable":true},"contactPhone":{"type":"string","nullable":true},"billingAddressLine1":{"type":"string","nullable":true},"billingAddressLine2":{"type":"string","nullable":true},"billingCity":{"type":"string","nullable":true},"billingState":{"type":"string","nullable":true},"billingZip":{"type":"string","nullable":true},"billingCountryCode":{"type":"string","nullable":true},"billingEmail":{"type":"string","nullable":true},"taxId":{"type":"string","nullable":true},"taxExempt":{"type":"boolean"},"taxExemptionNumber":{"type":"string","nullable":true},"currency":{"type":"string","nullable":true},"preferredPaymentMethod":{"type":"string","nullable":true},"paymentTerms":{"type":"string","nullable":true},"creditLimit":{"nullable":true},"bankName":{"type":"string","nullable":true},"bankAccountName":{"type":"string","nullable":true},"bankAccountNumber":{"type":"string","nullable":true},"bankRoutingNumber":{"type":"string","nullable":true},"bankSwiftCode":{"type":"string","nullable":true},"bankIban":{"type":"string","nullable":true},"industry":{"type":"string","nullable":true},"customerType":{"type":"string","nullable":true},"customerStatus":{"type":"string","nullable":true},"customerRating":{"type":"number","nullable":true},"discountTerms":{"type":"string","nullable":true},"latePaymentPenalty":{"nullable":true},"creditScore":{"type":"number","nullable":true},"customFields":{"type":"object","nullable":true,"additionalProperties":{}},"lastOrderDate":{"type":"string","nullable":true},"accountManager":{"type":"string","nullable":true},"shippingAddresses":{"type":"string","nullable":true},"billingAddresses":{"type":"string","nullable":true},"warehouseAddresses":{"type":"string","nullable":true},"billingCurrency":{"type":"string","nullable":true},"billingCycle":{"type":"string","nullable":true},"invoiceDeliveryMethod":{"type":"string","nullable":true},"invoiceFormat":{"type":"string","nullable":true},"purchaseOrderRequired":{"type":"boolean"},"autoInvoice":{"type":"boolean"},"taxExemptionExpiry":{"type":"string","nullable":true},"taxJurisdiction":{"type":"string","nullable":true},"taxClassification":{"type":"string","nullable":true},"withholdingTaxRate":{"nullable":true},"taxDocuments":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"type":{"type":"string"},"jurisdiction":{"type":"string"},"issuedBy":{"type":"string"},"validFrom":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"validTo":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"url":{"type":"string","format":"uri"}}}},"availableCredit":{"nullable":true},"riskRating":{"type":"string","nullable":true},"insurancePolicy":{"type":"string","nullable":true},"insuranceExpiry":{"type":"string","nullable":true},"insuranceCoverage":{"nullable":true},"earlyPaymentDiscount":{"nullable":true},"minimumOrderValue":{"nullable":true},"maximumOrderValue":{"nullable":true},"averagePaymentDays":{"type":"number","nullable":true},"paymentFrequency":{"type":"string","nullable":true},"bankAccounts":{"type":"array","nullable":true,"items":{"type":"object","properties":{"bankName":{"type":"string"},"holderName":{"type":"string"},"accountNumber":{"type":"string"},"routingNumber":{"type":"string"},"swift":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"type":{"type":"string"},"isPrimary":{"type":"boolean"}}}},"contractStartDate":{"type":"string","nullable":true},"contractEndDate":{"type":"string","nullable":true},"contractRenewalDate":{"type":"string","nullable":true},"contractStatus":{"type":"string","nullable":true},"legalStatus":{"type":"string","nullable":true},"complianceStatus":{"type":"string","nullable":true},"certifications":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"issuer":{"type":"string"},"issuedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"expiresAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"url":{"type":"string","format":"uri"}},"required":["name"]}},"licenses":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"number":{"type":"string"},"issuer":{"type":"string"},"issuedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"expiresAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"url":{"type":"string","format":"uri"}},"required":["name"]}},"ndaStatus":{"type":"boolean"},"ndaExpiryDate":{"type":"string","nullable":true},"customerSegment":{"type":"string","nullable":true},"accountTier":{"type":"string","nullable":true},"leadSource":{"type":"string","nullable":true},"marketingCampaigns":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"source":{"type":"string"},"medium":{"type":"string"},"campaignId":{"type":"string"},"channel":{"type":"string"},"startedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"endedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"budget":{"type":"number","minimum":0},"spend":{"type":"number","minimum":0},"clicks":{"type":"integer","minimum":0},"conversions":{"type":"integer","minimum":0}},"required":["name"]}},"preferredLanguage":{"type":"string","nullable":true},"communicationPreferences":{"type":"object","nullable":true,"properties":{"email":{"type":"object","properties":{"newsletters":{"type":"boolean","default":false},"promotions":{"type":"boolean","default":false},"productUpdates":{"type":"boolean","default":true}}},"phone":{"type":"object","properties":{"sms":{"type":"boolean","default":false},"calls":{"type":"boolean","default":false}}},"channels":{"type":"array","items":{"type":"string"}},"preferredLanguage":{"type":"string"},"preferredTimes":{"type":"array","items":{"type":"string"}}}},"subscriptionStatus":{"type":"string","nullable":true},"loyaltyPoints":{"type":"number","nullable":true},"referralSource":{"type":"string","nullable":true},"referralCode":{"type":"string","nullable":true},"lifetimeValue":{"nullable":true},"acquisitionCost":{"nullable":true},"retentionRate":{"nullable":true},"satisfactionScore":{"type":"number","nullable":true},"lastReviewDate":{"type":"string","nullable":true},"nextReviewDate":{"type":"string","nullable":true},"erpId":{"type":"string","nullable":true},"crmId":{"type":"string","nullable":true},"accountingId":{"type":"string","nullable":true},"lastLoginDate":{"type":"string","nullable":true},"lastInteractionDate":{"type":"string","nullable":true},"totalOrders":{"type":"number","nullable":true},"totalReturns":{"type":"number","nullable":true},"activeSubscriptions":{"type":"number","nullable":true},"metadata":{"type":"object","nullable":true,"additionalProperties":{}},"notes":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"author":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"email":{"type":"string","format":"email"}}},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"visibility":{"type":"string","enum":["internal","public"],"default":"internal"},"content":{"type":"string"}},"required":["content"]}}},"required":["id","name","email","avatar","externalId","stripeCustomerId","linkId","clickId","clickedAt","country","projectId","projectConnectId","createdAt","updatedAt","addressLine1","addressLine2","city","contact","countryCode","state","zip","note","phone","token","vatNumber","website","companyName","tradingName","registrationNumber","isVendor","alternativePhone","fax","contactTitle","contactEmail","contactPhone","billingAddressLine1","billingAddressLine2","billingCity","billingState","billingZip","billingCountryCode","billingEmail","taxId","taxExempt","taxExemptionNumber","currency","preferredPaymentMethod","paymentTerms","bankName","bankAccountName","bankAccountNumber","bankRoutingNumber","bankSwiftCode","bankIban","industry","customerType","customerStatus","customerRating","discountTerms","creditScore","customFields","lastOrderDate","accountManager","shippingAddresses","billingAddresses","warehouseAddresses","billingCurrency","billingCycle","invoiceDeliveryMethod","invoiceFormat","purchaseOrderRequired","autoInvoice","taxExemptionExpiry","taxJurisdiction","taxClassification","taxDocuments","riskRating","insurancePolicy","insuranceExpiry","averagePaymentDays","paymentFrequency","bankAccounts","contractStartDate","contractEndDate","contractRenewalDate","contractStatus","legalStatus","complianceStatus","certifications","licenses","ndaStatus","ndaExpiryDate","customerSegment","accountTier","leadSource","marketingCampaigns","preferredLanguage","communicationPreferences","subscriptionStatus","loyaltyPoints","referralSource","referralCode","satisfactionScore","lastReviewDate","nextReviewDate","erpId","crmId","accountingId","lastLoginDate","lastInteractionDate","totalOrders","totalReturns","activeSubscriptions","metadata","notes"]},"click":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"country":{"type":"string"},"city":{"type":"string"},"region":{"type":"string"},"continent":{"type":"string"},"device":{"type":"string"},"browser":{"type":"string"},"os":{"type":"string"},"referer":{"type":"string"},"refererUrl":{"type":"string"},"qr":{"type":"boolean"},"ip":{"type":"string"}},"required":["id","url","country","city","region","continent","device","browser","os","referer","refererUrl","ip"]},"link":{"type":"object","properties":{"id":{"type":"string"},"domain":{"type":"string"},"key":{"type":"string","minLength":1,"maxLength":100},"url":{"type":"string","format":"uri"},"shortLink":{"type":"string","format":"uri"},"archived":{"type":"boolean"},"expiresAt":{"type":"string","nullable":true},"expiredUrl":{"type":"string","nullable":true,"format":"uri"},"password":{"type":"string","nullable":true,"minLength":6},"trackConversion":{"type":"boolean","default":true},"proxy":{"type":"boolean","default":false},"title":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true,"maxLength":1000},"image":{"type":"string","nullable":true,"format":"uri"},"video":{"type":"string","nullable":true,"format":"uri"},"utm_source":{"type":"string","nullable":true,"maxLength":100},"utm_medium":{"type":"string","nullable":true,"maxLength":100},"utm_campaign":{"type":"string","nullable":true,"maxLength":200},"utm_term":{"type":"string","nullable":true,"maxLength":100},"utm_content":{"type":"string","nullable":true,"maxLength":200},"rewrite":{"type":"boolean"},"doIndex":{"type":"boolean","default":false},"ios":{"type":"string","nullable":true,"format":"uri"},"android":{"type":"string","nullable":true,"format":"uri"},"geo":{"type":"object","nullable":true,"additionalProperties":{"type":"string","format":"uri"}},"userId":{"type":"string","nullable":true},"projectId":{"type":"string","nullable":true},"externalId":{"type":"string","nullable":true},"tenantId":{"type":"string","nullable":true},"publicStats":{"type":"boolean","default":false},"clicks":{"type":"number","minimum":0,"default":0},"lastClicked":{"type":"string","nullable":true},"leads":{"type":"number","minimum":0,"default":0},"sales":{"type":"number","minimum":0,"default":0},"saleAmount":{"type":"number","minimum":0,"default":0},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"comments":{"type":"string","nullable":true},"programId":{"type":"string","nullable":true},"type":{"type":"string","enum":["standard","smart","campaign","qr","bio","redirect"],"default":"standard"},"status":{"type":"string","enum":["active","paused","expired","archived","deleted"],"default":"active"},"maxClicks":{"type":"number","nullable":true,"minimum":0,"exclusiveMinimum":true},"uniqueClicks":{"type":"number","minimum":0,"default":0},"metadata":{"type":"object","nullable":true,"properties":{"tags":{"type":"array","items":{"type":"string"},"maxItems":10},"category":{"type":"string","maxLength":100},"notes":{"type":"string","maxLength":1000},"customFields":{"type":"object","additionalProperties":{}},"integrations":{"type":"object","additionalProperties":{}}}}},"required":["id","domain","key","url","shortLink","archived","expiresAt","expiredUrl","password","trackConversion","proxy","title","description","image","video","utm_source","utm_medium","utm_campaign","utm_term","utm_content","rewrite","doIndex","ios","android","geo","userId","projectId","externalId","tenantId","publicStats","clicks","lastClicked","leads","sales","saleAmount","createdAt","updatedAt","comments","programId","type","status","maxClicks","uniqueClicks","metadata"]}},"required":["eventName","customer","click","link"]}},"required":["id","event","createdAt","data"],"description":"Triggered when a lead is created."},"SaleCreatedEvent":{"type":"object","properties":{"id":{"type":"string"},"event":{"type":"string","enum":["sale.created"]},"createdAt":{"type":"string"},"data":{"type":"object","properties":{"eventName":{"type":"string"},"customer":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"avatar":{"type":"string","nullable":true},"externalId":{"type":"string","nullable":true},"stripeCustomerId":{"type":"string","nullable":true},"linkId":{"type":"string","nullable":true},"clickId":{"type":"string","nullable":true},"clickedAt":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"projectId":{"type":"string"},"projectConnectId":{"type":"string","nullable":true},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"addressLine1":{"type":"string","nullable":true},"addressLine2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"contact":{"type":"string","nullable":true},"countryCode":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"zip":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"vatNumber":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"companyName":{"type":"string","nullable":true},"tradingName":{"type":"string","nullable":true},"registrationNumber":{"type":"string","nullable":true},"isVendor":{"type":"boolean"},"alternativePhone":{"type":"string","nullable":true},"fax":{"type":"string","nullable":true},"contactTitle":{"type":"string","nullable":true},"contactEmail":{"type":"string","nullable":true},"contactPhone":{"type":"string","nullable":true},"billingAddressLine1":{"type":"string","nullable":true},"billingAddressLine2":{"type":"string","nullable":true},"billingCity":{"type":"string","nullable":true},"billingState":{"type":"string","nullable":true},"billingZip":{"type":"string","nullable":true},"billingCountryCode":{"type":"string","nullable":true},"billingEmail":{"type":"string","nullable":true},"taxId":{"type":"string","nullable":true},"taxExempt":{"type":"boolean"},"taxExemptionNumber":{"type":"string","nullable":true},"currency":{"type":"string","nullable":true},"preferredPaymentMethod":{"type":"string","nullable":true},"paymentTerms":{"type":"string","nullable":true},"creditLimit":{"nullable":true},"bankName":{"type":"string","nullable":true},"bankAccountName":{"type":"string","nullable":true},"bankAccountNumber":{"type":"string","nullable":true},"bankRoutingNumber":{"type":"string","nullable":true},"bankSwiftCode":{"type":"string","nullable":true},"bankIban":{"type":"string","nullable":true},"industry":{"type":"string","nullable":true},"customerType":{"type":"string","nullable":true},"customerStatus":{"type":"string","nullable":true},"customerRating":{"type":"number","nullable":true},"discountTerms":{"type":"string","nullable":true},"latePaymentPenalty":{"nullable":true},"creditScore":{"type":"number","nullable":true},"customFields":{"type":"object","nullable":true,"additionalProperties":{}},"lastOrderDate":{"type":"string","nullable":true},"accountManager":{"type":"string","nullable":true},"shippingAddresses":{"type":"string","nullable":true},"billingAddresses":{"type":"string","nullable":true},"warehouseAddresses":{"type":"string","nullable":true},"billingCurrency":{"type":"string","nullable":true},"billingCycle":{"type":"string","nullable":true},"invoiceDeliveryMethod":{"type":"string","nullable":true},"invoiceFormat":{"type":"string","nullable":true},"purchaseOrderRequired":{"type":"boolean"},"autoInvoice":{"type":"boolean"},"taxExemptionExpiry":{"type":"string","nullable":true},"taxJurisdiction":{"type":"string","nullable":true},"taxClassification":{"type":"string","nullable":true},"withholdingTaxRate":{"nullable":true},"taxDocuments":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"type":{"type":"string"},"jurisdiction":{"type":"string"},"issuedBy":{"type":"string"},"validFrom":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"validTo":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"url":{"type":"string","format":"uri"}}}},"availableCredit":{"nullable":true},"riskRating":{"type":"string","nullable":true},"insurancePolicy":{"type":"string","nullable":true},"insuranceExpiry":{"type":"string","nullable":true},"insuranceCoverage":{"nullable":true},"earlyPaymentDiscount":{"nullable":true},"minimumOrderValue":{"nullable":true},"maximumOrderValue":{"nullable":true},"averagePaymentDays":{"type":"number","nullable":true},"paymentFrequency":{"type":"string","nullable":true},"bankAccounts":{"type":"array","nullable":true,"items":{"type":"object","properties":{"bankName":{"type":"string"},"holderName":{"type":"string"},"accountNumber":{"type":"string"},"routingNumber":{"type":"string"},"swift":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"type":{"type":"string"},"isPrimary":{"type":"boolean"}}}},"contractStartDate":{"type":"string","nullable":true},"contractEndDate":{"type":"string","nullable":true},"contractRenewalDate":{"type":"string","nullable":true},"contractStatus":{"type":"string","nullable":true},"legalStatus":{"type":"string","nullable":true},"complianceStatus":{"type":"string","nullable":true},"certifications":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"issuer":{"type":"string"},"issuedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"expiresAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"url":{"type":"string","format":"uri"}},"required":["name"]}},"licenses":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"number":{"type":"string"},"issuer":{"type":"string"},"issuedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"expiresAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"url":{"type":"string","format":"uri"}},"required":["name"]}},"ndaStatus":{"type":"boolean"},"ndaExpiryDate":{"type":"string","nullable":true},"customerSegment":{"type":"string","nullable":true},"accountTier":{"type":"string","nullable":true},"leadSource":{"type":"string","nullable":true},"marketingCampaigns":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"source":{"type":"string"},"medium":{"type":"string"},"campaignId":{"type":"string"},"channel":{"type":"string"},"startedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"endedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"budget":{"type":"number","minimum":0},"spend":{"type":"number","minimum":0},"clicks":{"type":"integer","minimum":0},"conversions":{"type":"integer","minimum":0}},"required":["name"]}},"preferredLanguage":{"type":"string","nullable":true},"communicationPreferences":{"type":"object","nullable":true,"properties":{"email":{"type":"object","properties":{"newsletters":{"type":"boolean","default":false},"promotions":{"type":"boolean","default":false},"productUpdates":{"type":"boolean","default":true}}},"phone":{"type":"object","properties":{"sms":{"type":"boolean","default":false},"calls":{"type":"boolean","default":false}}},"channels":{"type":"array","items":{"type":"string"}},"preferredLanguage":{"type":"string"},"preferredTimes":{"type":"array","items":{"type":"string"}}}},"subscriptionStatus":{"type":"string","nullable":true},"loyaltyPoints":{"type":"number","nullable":true},"referralSource":{"type":"string","nullable":true},"referralCode":{"type":"string","nullable":true},"lifetimeValue":{"nullable":true},"acquisitionCost":{"nullable":true},"retentionRate":{"nullable":true},"satisfactionScore":{"type":"number","nullable":true},"lastReviewDate":{"type":"string","nullable":true},"nextReviewDate":{"type":"string","nullable":true},"erpId":{"type":"string","nullable":true},"crmId":{"type":"string","nullable":true},"accountingId":{"type":"string","nullable":true},"lastLoginDate":{"type":"string","nullable":true},"lastInteractionDate":{"type":"string","nullable":true},"totalOrders":{"type":"number","nullable":true},"totalReturns":{"type":"number","nullable":true},"activeSubscriptions":{"type":"number","nullable":true},"metadata":{"type":"object","nullable":true,"additionalProperties":{}},"notes":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"author":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"email":{"type":"string","format":"email"}}},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"visibility":{"type":"string","enum":["internal","public"],"default":"internal"},"content":{"type":"string"}},"required":["content"]}}},"required":["id","name","email","avatar","externalId","stripeCustomerId","linkId","clickId","clickedAt","country","projectId","projectConnectId","createdAt","updatedAt","addressLine1","addressLine2","city","contact","countryCode","state","zip","note","phone","token","vatNumber","website","companyName","tradingName","registrationNumber","isVendor","alternativePhone","fax","contactTitle","contactEmail","contactPhone","billingAddressLine1","billingAddressLine2","billingCity","billingState","billingZip","billingCountryCode","billingEmail","taxId","taxExempt","taxExemptionNumber","currency","preferredPaymentMethod","paymentTerms","bankName","bankAccountName","bankAccountNumber","bankRoutingNumber","bankSwiftCode","bankIban","industry","customerType","customerStatus","customerRating","discountTerms","creditScore","customFields","lastOrderDate","accountManager","shippingAddresses","billingAddresses","warehouseAddresses","billingCurrency","billingCycle","invoiceDeliveryMethod","invoiceFormat","purchaseOrderRequired","autoInvoice","taxExemptionExpiry","taxJurisdiction","taxClassification","taxDocuments","riskRating","insurancePolicy","insuranceExpiry","averagePaymentDays","paymentFrequency","bankAccounts","contractStartDate","contractEndDate","contractRenewalDate","contractStatus","legalStatus","complianceStatus","certifications","licenses","ndaStatus","ndaExpiryDate","customerSegment","accountTier","leadSource","marketingCampaigns","preferredLanguage","communicationPreferences","subscriptionStatus","loyaltyPoints","referralSource","referralCode","satisfactionScore","lastReviewDate","nextReviewDate","erpId","crmId","accountingId","lastLoginDate","lastInteractionDate","totalOrders","totalReturns","activeSubscriptions","metadata","notes"]},"click":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"country":{"type":"string"},"city":{"type":"string"},"region":{"type":"string"},"continent":{"type":"string"},"device":{"type":"string"},"browser":{"type":"string"},"os":{"type":"string"},"referer":{"type":"string"},"refererUrl":{"type":"string"},"qr":{"type":"boolean"},"ip":{"type":"string"}},"required":["id","url","country","city","region","continent","device","browser","os","referer","refererUrl","ip"]},"link":{"type":"object","properties":{"id":{"type":"string"},"domain":{"type":"string"},"key":{"type":"string","minLength":1,"maxLength":100},"url":{"type":"string","format":"uri"},"shortLink":{"type":"string","format":"uri"},"archived":{"type":"boolean"},"expiresAt":{"type":"string","nullable":true},"expiredUrl":{"type":"string","nullable":true,"format":"uri"},"password":{"type":"string","nullable":true,"minLength":6},"trackConversion":{"type":"boolean","default":true},"proxy":{"type":"boolean","default":false},"title":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true,"maxLength":1000},"image":{"type":"string","nullable":true,"format":"uri"},"video":{"type":"string","nullable":true,"format":"uri"},"utm_source":{"type":"string","nullable":true,"maxLength":100},"utm_medium":{"type":"string","nullable":true,"maxLength":100},"utm_campaign":{"type":"string","nullable":true,"maxLength":200},"utm_term":{"type":"string","nullable":true,"maxLength":100},"utm_content":{"type":"string","nullable":true,"maxLength":200},"rewrite":{"type":"boolean"},"doIndex":{"type":"boolean","default":false},"ios":{"type":"string","nullable":true,"format":"uri"},"android":{"type":"string","nullable":true,"format":"uri"},"geo":{"type":"object","nullable":true,"additionalProperties":{"type":"string","format":"uri"}},"userId":{"type":"string","nullable":true},"projectId":{"type":"string","nullable":true},"externalId":{"type":"string","nullable":true},"tenantId":{"type":"string","nullable":true},"publicStats":{"type":"boolean","default":false},"clicks":{"type":"number","minimum":0,"default":0},"lastClicked":{"type":"string","nullable":true},"leads":{"type":"number","minimum":0,"default":0},"sales":{"type":"number","minimum":0,"default":0},"saleAmount":{"type":"number","minimum":0,"default":0},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"comments":{"type":"string","nullable":true},"programId":{"type":"string","nullable":true},"type":{"type":"string","enum":["standard","smart","campaign","qr","bio","redirect"],"default":"standard"},"status":{"type":"string","enum":["active","paused","expired","archived","deleted"],"default":"active"},"maxClicks":{"type":"number","nullable":true,"minimum":0,"exclusiveMinimum":true},"uniqueClicks":{"type":"number","minimum":0,"default":0},"metadata":{"type":"object","nullable":true,"properties":{"tags":{"type":"array","items":{"type":"string"},"maxItems":10},"category":{"type":"string","maxLength":100},"notes":{"type":"string","maxLength":1000},"customFields":{"type":"object","additionalProperties":{}},"integrations":{"type":"object","additionalProperties":{}}}}},"required":["id","domain","key","url","shortLink","archived","expiresAt","expiredUrl","password","trackConversion","proxy","title","description","image","video","utm_source","utm_medium","utm_campaign","utm_term","utm_content","rewrite","doIndex","ios","android","geo","userId","projectId","externalId","tenantId","publicStats","clicks","lastClicked","leads","sales","saleAmount","createdAt","updatedAt","comments","programId","type","status","maxClicks","uniqueClicks","metadata"]},"sale":{"type":"object","properties":{"amount":{"type":"number"},"currency":{"type":"string"},"paymentProcessor":{"type":"string"},"invoiceId":{"type":"string","nullable":true}},"required":["amount","currency","paymentProcessor","invoiceId"]}},"required":["eventName","customer","click","link","sale"]}},"required":["id","event","createdAt","data"],"description":"Triggered when a sale is created."}},"parameters":{"PageParam":{"name":"page","in":"query","description":"Page number for pagination (default: 1)","required":false,"schema":{"type":"integer","minimum":1,"default":1}},"PageSizeParam":{"name":"pageSize","in":"query","description":"Number of items per page (default: 50, max: 100)","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},"SortParam":{"name":"sort","in":"query","description":"Sort field and direction (e.g., 'createdAt:desc')","required":false,"schema":{"type":"string","pattern":"^[a-zA-Z]+:(asc|desc)$"}},"SearchParam":{"name":"search","in":"query","description":"Search query to filter results","required":false,"schema":{"type":"string","minLength":1,"maxLength":100}}},"responses":{"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).","content":{"application/json":{"schema":{"x-speakeasy-name-override":"BadRequest","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request"],"description":"A short code indicating the error code returned.","example":"bad_request"},"message":{"x-speakeasy-error-message":true,"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found."},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://paperless.oppulence.app/docs/api-reference/errors#bad-request"}},"required":["code","message"]}},"required":["error"]}}}},"401":{"description":"Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response.","content":{"application/json":{"schema":{"x-speakeasy-name-override":"Unauthorized","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["unauthorized"],"description":"A short code indicating the error code returned.","example":"unauthorized"},"message":{"x-speakeasy-error-message":true,"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found."},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://paperless.oppulence.app/docs/api-reference/errors#unauthorized"}},"required":["code","message"]}},"required":["error"]}}}},"403":{"description":"The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.","content":{"application/json":{"schema":{"x-speakeasy-name-override":"Forbidden","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["forbidden"],"description":"A short code indicating the error code returned.","example":"forbidden"},"message":{"x-speakeasy-error-message":true,"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found."},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://paperless.oppulence.app/docs/api-reference/errors#forbidden"}},"required":["code","message"]}},"required":["error"]}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"schema":{"x-speakeasy-name-override":"NotFound","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["not_found"],"description":"A short code indicating the error code returned.","example":"not_found"},"message":{"x-speakeasy-error-message":true,"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found."},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://paperless.oppulence.app/docs/api-reference/errors#not-found"}},"required":["code","message"]}},"required":["error"]}}}},"409":{"description":"This response is sent when a request conflicts with the current state of the server.","content":{"application/json":{"schema":{"x-speakeasy-name-override":"Conflict","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["conflict"],"description":"A short code indicating the error code returned.","example":"conflict"},"message":{"x-speakeasy-error-message":true,"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found."},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://paperless.oppulence.app/docs/api-reference/errors#conflict"}},"required":["code","message"]}},"required":["error"]}}}},"410":{"description":"This response is sent when the requested content has been permanently deleted from server, with no forwarding address.","content":{"application/json":{"schema":{"x-speakeasy-name-override":"InviteExpired","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["invite_expired"],"description":"A short code indicating the error code returned.","example":"invite_expired"},"message":{"x-speakeasy-error-message":true,"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found."},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://paperless.oppulence.app/docs/api-reference/errors#invite-expired"}},"required":["code","message"]}},"required":["error"]}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"schema":{"x-speakeasy-name-override":"UnprocessableEntity","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["unprocessable_entity"],"description":"A short code indicating the error code returned.","example":"unprocessable_entity"},"message":{"x-speakeasy-error-message":true,"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found."},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://paperless.oppulence.app/docs/api-reference/errors#unprocessable-entity"}},"required":["code","message"]}},"required":["error"]}}}},"429":{"description":"The user has sent too many requests in a given amount of time (\"rate limiting\")","content":{"application/json":{"schema":{"x-speakeasy-name-override":"RateLimitExceeded","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"],"description":"A short code indicating the error code returned.","example":"rate_limit_exceeded"},"message":{"x-speakeasy-error-message":true,"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found."},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://paperless.oppulence.app/docs/api-reference/errors#rate-limit_exceeded"}},"required":["code","message"]}},"required":["error"]}}}},"500":{"description":"The server has encountered a situation it does not know how to handle.","content":{"application/json":{"schema":{"x-speakeasy-name-override":"InternalServerError","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["internal_server_error"],"description":"A short code indicating the error code returned.","example":"internal_server_error"},"message":{"x-speakeasy-error-message":true,"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found."},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://paperless.oppulence.app/docs/api-reference/errors#internal-server_error"}},"required":["code","message"]}},"required":["error"]}}}}}}}