@epilot/sdk 2.20.15 → 2.20.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/definitions/access-token.json +0 -15
- package/definitions/file.json +3 -2
- package/definitions/pricing.json +77 -9
- package/dist/access-token-ADVHFJ63.js +7 -0
- package/dist/access-token-CQMYWZIG.cjs +7 -0
- package/dist/{access-token.d-OiCg1gnT.d.cts → access-token.d-Yy-yrft_.d.cts} +1 -9
- package/dist/{access-token.d-OiCg1gnT.d.ts → access-token.d-Yy-yrft_.d.ts} +1 -9
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.d.cts +2 -2
- package/dist/apis/access-token.d.ts +2 -2
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.d.cts +2 -2
- package/dist/apis/pricing.d.ts +2 -2
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/snapshot.cjs +6 -6
- package/dist/apis/snapshot.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/{chunk-YFFICVOA.js → chunk-HQJ5AG4I.js} +3 -3
- package/dist/{chunk-FXIH3QBV.cjs → chunk-OZHARSW5.cjs} +3 -3
- package/dist/{file-LFOTXMRJ.cjs → file-2KT6MMMG.cjs} +1 -1
- package/dist/{file-ND2JH5EM.js → file-N3SGGI6E.js} +1 -1
- package/dist/index.cjs +8 -8
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +1 -1
- package/dist/{pricing-PFTFDGZ3.cjs → pricing-WMGQHFJV.cjs} +1 -1
- package/dist/{pricing-YZHONV3M.js → pricing-WNSMDD5D.js} +1 -1
- package/dist/{pricing.d-CvcYBm8A.d.cts → pricing.d-CuF7KcXt.d.cts} +80 -67
- package/dist/{pricing.d-CvcYBm8A.d.ts → pricing.d-CuF7KcXt.d.ts} +80 -67
- package/docs/access-token.md +0 -15
- package/docs/file.md +1 -1
- package/docs/pricing.md +2 -2
- package/package.json +1 -1
- package/dist/access-token-E2XEMQMG.cjs +0 -7
- package/dist/access-token-IBKEXWNA.js +0 -7
|
@@ -94,7 +94,6 @@
|
|
|
94
94
|
"portal_id": "portal_abc123",
|
|
95
95
|
"contact_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
96
96
|
"surface_id": "website-journeys",
|
|
97
|
-
"origin": "END_CUSTOMER_PORTAL",
|
|
98
97
|
"allowed_operations": [
|
|
99
98
|
"getContact",
|
|
100
99
|
"getContracts"
|
|
@@ -665,14 +664,6 @@
|
|
|
665
664
|
"description": "Contact entity ID for access token type \"contact_identification\"",
|
|
666
665
|
"example": "5da0a718-c822-403d-9f5d-20d4584e0528"
|
|
667
666
|
},
|
|
668
|
-
"PortalOrigin": {
|
|
669
|
-
"type": "string",
|
|
670
|
-
"enum": [
|
|
671
|
-
"END_CUSTOMER_PORTAL",
|
|
672
|
-
"INSTALLER_PORTAL"
|
|
673
|
-
],
|
|
674
|
-
"description": "Portal origin the token assumes, so the bearer is permission-masked the same way the corresponding portal role is."
|
|
675
|
-
},
|
|
676
667
|
"AllowedOperations": {
|
|
677
668
|
"type": "array",
|
|
678
669
|
"description": "openapi operationIds the token may call. Enforced by the API that consumes the token, which must additionally deny any operation not on this list. Baked into the token at issue time so widening the consumer's own allowlist later cannot retroactively widen a token that is already in circulation.",
|
|
@@ -928,9 +919,6 @@
|
|
|
928
919
|
"description": "Portal surface the token is issued for (see `surfaces` on the portal config in customer-portal-api). Carried as the `custom:surface_id` claim; the consuming API resolves the surface's data access from the portal config on every request.",
|
|
929
920
|
"example": "website-journeys"
|
|
930
921
|
},
|
|
931
|
-
"origin": {
|
|
932
|
-
"$ref": "#/components/schemas/PortalOrigin"
|
|
933
|
-
},
|
|
934
922
|
"allowed_operations": {
|
|
935
923
|
"$ref": "#/components/schemas/AllowedOperations"
|
|
936
924
|
},
|
|
@@ -984,9 +972,6 @@
|
|
|
984
972
|
"contact_id": {
|
|
985
973
|
"$ref": "#/components/schemas/ContactId"
|
|
986
974
|
},
|
|
987
|
-
"origin": {
|
|
988
|
-
"$ref": "#/components/schemas/PortalOrigin"
|
|
989
|
-
},
|
|
990
975
|
"allowed_operations": {
|
|
991
976
|
"$ref": "#/components/schemas/AllowedOperations"
|
|
992
977
|
},
|
package/definitions/file.json
CHANGED
|
@@ -2961,9 +2961,10 @@
|
|
|
2961
2961
|
"enum": [
|
|
2962
2962
|
"completed",
|
|
2963
2963
|
"pending",
|
|
2964
|
-
"failed"
|
|
2964
|
+
"failed",
|
|
2965
|
+
"skipped"
|
|
2965
2966
|
],
|
|
2966
|
-
"description": "`completed` when every rule was evaluated. `pending` is reserved for check levels that\nneed asynchronous content extraction; `failed` when the observation could not be produced.\n"
|
|
2967
|
+
"description": "`completed` when every rule was evaluated. `pending` is reserved for check levels that\nneed asynchronous content extraction; `failed` when the observation could not be produced;\n`skipped` when document validation is not enabled for the organisation - the file was not\nread and `results` is empty, so callers treat the file as accepted.\n"
|
|
2967
2968
|
},
|
|
2968
2969
|
"file": {
|
|
2969
2970
|
"$ref": "#/components/schemas/FileValidationFile"
|
package/definitions/pricing.json
CHANGED
|
@@ -3547,6 +3547,35 @@
|
|
|
3547
3547
|
}
|
|
3548
3548
|
]
|
|
3549
3549
|
}
|
|
3550
|
+
},
|
|
3551
|
+
"A variant carrying overrides that did not apply": {
|
|
3552
|
+
"summary": "`unit_amount_currency` reads as the entity's own value rather than the variant's, and `_inert_overrides` says why each stored override was passed over",
|
|
3553
|
+
"value": {
|
|
3554
|
+
"results": [
|
|
3555
|
+
{
|
|
3556
|
+
"_id": "price-sp26d1yo",
|
|
3557
|
+
"_variant_id": "var-46045",
|
|
3558
|
+
"_version_valid_from": "2027-01-01T00:00:00.000Z",
|
|
3559
|
+
"_conditions": {
|
|
3560
|
+
"postal_code": "46045",
|
|
3561
|
+
"default": false
|
|
3562
|
+
},
|
|
3563
|
+
"_inert_overrides": [
|
|
3564
|
+
{
|
|
3565
|
+
"attribute": "unit_amount_currency",
|
|
3566
|
+
"reason": "ATTRIBUTE_NOT_OVERRIDABLE"
|
|
3567
|
+
},
|
|
3568
|
+
{
|
|
3569
|
+
"attribute": "legacy_surcharge",
|
|
3570
|
+
"reason": "ATTRIBUTE_UNDECLARED"
|
|
3571
|
+
}
|
|
3572
|
+
],
|
|
3573
|
+
"_schema": "price",
|
|
3574
|
+
"unit_amount": 2499,
|
|
3575
|
+
"unit_amount_currency": "EUR"
|
|
3576
|
+
}
|
|
3577
|
+
]
|
|
3578
|
+
}
|
|
3550
3579
|
}
|
|
3551
3580
|
}
|
|
3552
3581
|
}
|
|
@@ -3597,7 +3626,7 @@
|
|
|
3597
3626
|
},
|
|
3598
3627
|
"/v1/conditional-pricing/{slug}/entities/{entity_id}/variants": {
|
|
3599
3628
|
"post": {
|
|
3600
|
-
"description": "Creates one variant of a conditional entity, together with the first version carrying its\nvalues: a variant always has at least one version.\n\nThe body pins the situation the variant applies to. Pins are exact values only — predicates\nare a read-side concept and are rejected here — and are stored canonicalized for their\ncondition's type, so two spellings of one instant, or one town written two ways, are one\nvariant rather than two that no context can tell apart.\n\nThree write rules are worth knowing before the first call:\n\n- A variant must pin at least one condition or be marked `default`. A variant pinning nothing\n would be a universal wildcard matching every resolve, which is a far more dangerous thing\n than a fallback and far easier to create by accident.\n- `default` is a property of the variant, set by the `default` flag, and is never a value in\n `conditions` — not even `false`. A `default` variant cannot pin anything else, and an entity\n can have only one; a second is refused as `TUPLE_CONFLICT`. Any entity may have one;\n nothing is declared in the schema to allow it.\n- Condition values are immutable afterwards. A variant's identity is the situation it applies\n to, and orders and contracts pin it. **A condition added to a schema that already has\n variants is effectively one-way**: every existing variant is a wildcard on the new\n dimension, but the first variant that pins it is ambiguous against all of them, and\n retro-pinning the others is blocked by this same rule.\n\nAttribute values are applied only for attributes currently carrying `overridable_attribute`.\nMetadata and non-overridable fields present in the body are not applied rather than rejected,\nand
|
|
3629
|
+
"description": "Creates one variant of a conditional entity, together with the first version carrying its\nvalues: a variant always has at least one version.\n\nThe body pins the situation the variant applies to. Pins are exact values only — predicates\nare a read-side concept and are rejected here — and are stored canonicalized for their\ncondition's type, so two spellings of one instant, or one town written two ways, are one\nvariant rather than two that no context can tell apart.\n\nThree write rules are worth knowing before the first call:\n\n- A variant must pin at least one condition or be marked `default`. A variant pinning nothing\n would be a universal wildcard matching every resolve, which is a far more dangerous thing\n than a fallback and far easier to create by accident.\n- `default` is a property of the variant, set by the `default` flag, and is never a value in\n `conditions` — not even `false`. A `default` variant cannot pin anything else, and an entity\n can have only one; a second is refused as `TUPLE_CONFLICT`. Any entity may have one;\n nothing is declared in the schema to allow it.\n- Condition values are immutable afterwards. A variant's identity is the situation it applies\n to, and orders and contracts pin it. **A condition added to a schema that already has\n variants is effectively one-way**: every existing variant is a wildcard on the new\n dimension, but the first variant that pins it is ambiguous against all of them, and\n retro-pinning the others is blocked by this same rule.\n\nAttribute values are applied only for attributes currently carrying `overridable_attribute`.\nMetadata and non-overridable fields present in the body are not applied rather than rejected,\nand every one but the metadata is named in the response's `warnings`, so a client working from\na slightly stale schema snapshot still succeeds and still learns which fields did not land.\nMetadata is never named, since a client echoing back a payload it read carries it in every\nbody.\n\n`variant_id` is always server-generated and returned, and is not accepted in the body — the\nrequest schema admits no such property. It is the durable key orders and contracts pin.\n",
|
|
3601
3630
|
"operationId": "$createConditionalVariant",
|
|
3602
3631
|
"summary": "$createConditionalVariant",
|
|
3603
3632
|
"tags": [
|
|
@@ -3642,12 +3671,51 @@
|
|
|
3642
3671
|
"application/json": {
|
|
3643
3672
|
"schema": {
|
|
3644
3673
|
"$ref": "#/components/schemas/CreatedVariant"
|
|
3674
|
+
},
|
|
3675
|
+
"examples": {
|
|
3676
|
+
"A body naming attributes this variant may not override": {
|
|
3677
|
+
"summary": "The write succeeded and `values` holds what was stored, so the two attributes the warning names are absent from it",
|
|
3678
|
+
"value": {
|
|
3679
|
+
"variant_id": "var-46045",
|
|
3680
|
+
"entity_id": "price-sp26d1yo",
|
|
3681
|
+
"schema": "price",
|
|
3682
|
+
"conditions": {
|
|
3683
|
+
"postal_code": "46045",
|
|
3684
|
+
"default": false
|
|
3685
|
+
},
|
|
3686
|
+
"valid_from": "2027-01-01T00:00:00.000Z",
|
|
3687
|
+
"values": {
|
|
3688
|
+
"unit_amount": 2499
|
|
3689
|
+
},
|
|
3690
|
+
"_created_at": "2026-12-01T09:15:00.000Z",
|
|
3691
|
+
"_updated_at": "2026-12-01T09:15:00.000Z",
|
|
3692
|
+
"_revision": 1,
|
|
3693
|
+
"warnings": [
|
|
3694
|
+
{
|
|
3695
|
+
"code": "ATTRIBUTES_NOT_APPLIED",
|
|
3696
|
+
"message": "The values sent for 2 attributes were not applied: unit_amount_currency, legacy_surcharge",
|
|
3697
|
+
"details": {
|
|
3698
|
+
"attributes": [
|
|
3699
|
+
{
|
|
3700
|
+
"attribute": "unit_amount_currency",
|
|
3701
|
+
"reason": "ATTRIBUTE_NOT_OVERRIDABLE"
|
|
3702
|
+
},
|
|
3703
|
+
{
|
|
3704
|
+
"attribute": "legacy_surcharge",
|
|
3705
|
+
"reason": "ATTRIBUTE_UNDECLARED"
|
|
3706
|
+
}
|
|
3707
|
+
]
|
|
3708
|
+
}
|
|
3709
|
+
}
|
|
3710
|
+
]
|
|
3711
|
+
}
|
|
3712
|
+
}
|
|
3645
3713
|
}
|
|
3646
3714
|
}
|
|
3647
3715
|
}
|
|
3648
3716
|
},
|
|
3649
3717
|
"400": {
|
|
3650
|
-
"description": "The variant cannot be created as described: it pins nothing and is not the default\n(`VARIANT_UNPINNED`), pins a condition the schema does not declare\n(`CONDITION_UNDEFINED`), pins a `select` value
|
|
3718
|
+
"description": "The variant cannot be created as described: it pins nothing and is not the default\n(`VARIANT_UNPINNED`), pins a condition the schema does not declare\n(`CONDITION_UNDEFINED`), pins a `select` value the condition's vocabulary does not admit\n(`CONDITION_VALUE_INVALID`), carries a value malformed for its condition's type\n(`PIN_FORMAT_INVALID`), or the entity already holds every variant it may hold\n(`VARIANT_LIMIT_REACHED`).\n\nSeveral refusals on this response carry no code, and testing `code` for absence is how\nthey are told from the five above: pinning the fallback marker directly under either of\nits names (`default` or `_default`), marking a variant `default` while it also pins a\nreal condition, pinning a condition whose declared type this deploy cannot read, and a\n`valid_from` this store cannot sort by. Each is an integration mistake rather than one\nbad row in a source file.\n\nAlso refused here: an entity id belonging to another type than the slug names\n(`ENTITY_TYPE_MISMATCH`), and an entity that was never created as a conditional one\n(`ENTITY_NOT_CONDITIONAL`).\n",
|
|
3651
3719
|
"content": {
|
|
3652
3720
|
"application/json": {
|
|
3653
3721
|
"schema": {
|
|
@@ -5153,7 +5221,7 @@
|
|
|
5153
5221
|
"warnings": [
|
|
5154
5222
|
{
|
|
5155
5223
|
"code": "ATTRIBUTES_NOT_APPLIED",
|
|
5156
|
-
"message": "description was not applied",
|
|
5224
|
+
"message": "The value sent for description was not applied",
|
|
5157
5225
|
"details": {
|
|
5158
5226
|
"attributes": [
|
|
5159
5227
|
{
|
|
@@ -5170,7 +5238,7 @@
|
|
|
5170
5238
|
"entity_id": "price-sp26d1yo",
|
|
5171
5239
|
"warnings": [],
|
|
5172
5240
|
"error": {
|
|
5173
|
-
"message": "segment
|
|
5241
|
+
"message": "The value pinned for condition segment is not one of its declared options",
|
|
5174
5242
|
"code": "CONDITION_VALUE_INVALID",
|
|
5175
5243
|
"details": {
|
|
5176
5244
|
"condition_name": "segment",
|
|
@@ -5451,7 +5519,7 @@
|
|
|
5451
5519
|
},
|
|
5452
5520
|
"options": {
|
|
5453
5521
|
"type": "array",
|
|
5454
|
-
"description": "The declared vocabulary of a `select` condition. Absent for every other type.\n\nThe same shape a `select` condition's `options` has on the Entity API, item for item: an\nentry is either the value itself or an object carrying that value and an optional display\n`title`. A `title` is never pinned by a variant and never matched — two entries differing\nonly in their title are one vocabulary entry.\n\nThe vocabulary is always closed: a condition carries no flag widening it, so a pinned\nvalue outside a declared vocabulary is rejected with `CONDITION_VALUE_INVALID`. It is
|
|
5522
|
+
"description": "The declared vocabulary of a `select` condition. Absent for every other type.\n\nThe same shape a `select` condition's `options` has on the Entity API, item for item: an\nentry is either the value itself or an object carrying that value and an optional display\n`title`. A `title` is never pinned by a variant and never matched — two entries differing\nonly in their title are one vocabulary entry.\n\nThe vocabulary is always closed: a condition carries no flag widening it, so a pinned\nvalue outside a declared vocabulary is rejected with `CONDITION_VALUE_INVALID`. A\nvocabulary that declares nothing is closed too — while `options` is absent or empty, or\nholds nothing this deploy can read, the condition admits no pin at all and the same code\nis returned with an empty `options`. It is *not* enforced on resolve — a vocabulary says\nwhat may be stored, not what may be asked for, so a context value outside it is a query\nthat simply matches nothing.\n",
|
|
5455
5523
|
"items": {
|
|
5456
5524
|
"anyOf": [
|
|
5457
5525
|
{
|
|
@@ -5541,7 +5609,7 @@
|
|
|
5541
5609
|
},
|
|
5542
5610
|
"ConditionalPricingErrorCode": {
|
|
5543
5611
|
"type": "string",
|
|
5544
|
-
"description": "Machine-readable failure mode of a conditional-pricing operation, allowing clients\nto branch on the kind of failure instead of parsing the error message.\n\n- `SCHEMA_NOT_FOUND` (404): no conditional entity type by that slug\n- `ENTITY_NOT_FOUND` (404): the schema holds no entity with that id\n- `ENTITY_TYPE_MISMATCH` (400): that id belongs to an entity of another type than the slug named\n- `ENTITY_NOT_CONDITIONAL` (400): the entity is of the right type but was not created as a conditional one\n- `VARIANT_NOT_FOUND` (404): the entity has no such variant\n- `VERSION_NOT_FOUND` (404): the variant has no version at that `valid_from`\n- `NO_MATCHES` (404): nothing applied to the context and the entity has no `default` variant\n- `NO_ACTIVE_VERSION` (404): the variant has no version in effect at the instant asked about\n- `AMBIGUOUS_RESOLUTION` (409): several variants match the given context while a single result was requested\n- `TUPLE_CONFLICT` (409): the condition tuple is already claimed by another variant\n- `VERSION_CONFLICT` (409): a version already exists at the given `valid_from` on that variant\n- `CONDITION_UNDEFINED` (400): a resolve context, a listing filter or a variant's pins name a condition the entity's schema does not define\n- `OPERATOR_UNSUPPORTED` (400): the requested operator is not applicable to the condition's type\n- `CONTEXT_FORMAT_INVALID` (400): a resolve context or listing filter value is malformed for its condition type\n- `CONDITION_VALUE_INVALID` (400): a variant write pins a `select` value the condition's
|
|
5612
|
+
"description": "Machine-readable failure mode of a conditional-pricing operation, allowing clients\nto branch on the kind of failure instead of parsing the error message.\n\n- `SCHEMA_NOT_FOUND` (404): no conditional entity type by that slug\n- `ENTITY_NOT_FOUND` (404): the schema holds no entity with that id\n- `ENTITY_TYPE_MISMATCH` (400): that id belongs to an entity of another type than the slug named\n- `ENTITY_NOT_CONDITIONAL` (400): the entity is of the right type but was not created as a conditional one\n- `VARIANT_NOT_FOUND` (404): the entity has no such variant\n- `VERSION_NOT_FOUND` (404): the variant has no version at that `valid_from`\n- `NO_MATCHES` (404): nothing applied to the context and the entity has no `default` variant\n- `NO_ACTIVE_VERSION` (404): the variant has no version in effect at the instant asked about\n- `AMBIGUOUS_RESOLUTION` (409): several variants match the given context while a single result was requested\n- `TUPLE_CONFLICT` (409): the condition tuple is already claimed by another variant\n- `VERSION_CONFLICT` (409): a version already exists at the given `valid_from` on that variant\n- `CONDITION_UNDEFINED` (400): a resolve context, a listing filter or a variant's pins name a condition the entity's schema does not define\n- `OPERATOR_UNSUPPORTED` (400): the requested operator is not applicable to the condition's type\n- `CONTEXT_FORMAT_INVALID` (400): a resolve context or listing filter value is malformed for its condition type\n- `CONDITION_VALUE_INVALID` (400): a variant write pins a `select` value the condition's `options` do not admit, including every pin on a condition whose `options` are absent, empty or unreadable\n- `TOO_MANY_MATCHES` (400): a multi-match resolve exceeded its result cap\n- `WRITE_CONFLICT` (409): transient write contention, retryable unlike `TUPLE_CONFLICT`\n- `OFFSET_WINDOW_EXCEEDED` (400): a listing's `from` plus `size` reaches past the offset window the search index allows\n- `CURSOR_INVALID` (400): a paging cursor cannot be read, or does not belong to the read it was sent with\n- `VARIANT_LIMIT_REACHED` (400): the entity already holds every variant it may hold\n- `PIN_FORMAT_INVALID` (400): a variant pins a value malformed for its condition's type\n- `VARIANT_UNPINNED` (400): a variant write pins no condition and is not marked `default`, or a batch delete item addresses no variant\n- `LAST_VERSION_UNDELETABLE` (400): the delete would leave the variant with no version at all\n\nIn a batch, the last four are the refusals an importer branches on: `VARIANT_LIMIT_REACHED`\nmeans stop the import, `PIN_FORMAT_INVALID` means one bad row, `LAST_VERSION_UNDELETABLE`\nmeans delete the variant instead.\n\nNot every refusal has a code. These carry a message and neither `code` nor `details`, and\neach operation's `400` names its own: a write pinning the reserved marker (`default` or\n`_default`), a variant marked `default` that also pins a real condition, a pin on a condition\nwhose declared type this deploy cannot read, an id this store cannot key by, a `valid_from`\nthis store cannot sort by, and a version write or delete with no `_revision`. Testing `code`\nfor absence is how a client tells them from the coded failures.\n\nFour of the 404s say that something the request addressed does not exist, and are fixed by\ncorrecting an id or accepting the thing is gone. The other two say the opposite: everything\naddressed exists and there is still nothing to serve — no variant applies to this situation,\nor none of a variant's versions is in effect yet. Those are ordinary business outcomes, told\napart from a wrong id by their code.\n\n`ENTITY_TYPE_MISMATCH` and `ENTITY_NOT_CONDITIONAL` are `400`s, not 404s: the entity the\nrequest addressed **was** found, and the fix is the slug beside it. A slug that names no\nconditional entity type at all is a `400` too.\n\nEach code is emitted with the HTTP status shown above, and only with that status, and each\none is pinned by a member of `ConditionalPricingError` — which is where the structured data\nthat code carries is declared.\n",
|
|
5545
5613
|
"enum": [
|
|
5546
5614
|
"SCHEMA_NOT_FOUND",
|
|
5547
5615
|
"ENTITY_NOT_FOUND",
|
|
@@ -5795,7 +5863,7 @@
|
|
|
5795
5863
|
"VariantValues": {
|
|
5796
5864
|
"type": "object",
|
|
5797
5865
|
"additionalProperties": true,
|
|
5798
|
-
"description": "The attribute values this version overrides on the base entity, keyed by attribute name.\n\nOnly attributes currently declaring `overridable_attribute` are applied. Metadata fields\n(anything underscore-prefixed), readonly attributes, hidden attributes, computed attributes
|
|
5866
|
+
"description": "The attribute values this version overrides on the base entity, keyed by attribute name.\n\nOnly attributes currently declaring `overridable_attribute` are applied. Metadata fields\n(anything underscore-prefixed), readonly attributes, hidden attributes, computed attributes,\nattributes of a type no variant may override and non-overridable attributes present here are\nnot applied rather than rejected, and every one but the metadata is named in the write's\n`warnings`, so a client working from a slightly stale schema snapshot still succeeds instead\nof failing on fields it could not have known to drop, and still learns which of them did not\nland. Metadata is never named, since a client echoing back a payload it read carries it in\nevery body. An attribute's `render_condition` says when to show it and has no\nbearing on whether a variant may override it.\n\nNot applied means *not updated*, never *removed*: a value already stored for an attribute that\nis not currently overridable is preserved, so removing and restoring the flag deactivates and\nthen reactivates the same override. An append seeds the attributes the variant may not\noverride from the version in effect at its own `valid_from`, so its stored values are not a\npure function of the body that wrote it; a variant's first version, and an append dated before\nthe variant's earliest version, inherit nothing.\n\nA composite price's `price_components` is an ordinary overridable relation attribute. A\ncomposite variant's override references different component *entities*, never a variant or a\nversion of one, and holds whatever a relation attribute ordinarily holds — this API defines no\nreference shape of its own.\n",
|
|
5799
5867
|
"example": {
|
|
5800
5868
|
"unit_amount": 2499,
|
|
5801
5869
|
"unit_amount_decimal": "24.99"
|
|
@@ -7533,7 +7601,7 @@
|
|
|
7533
7601
|
},
|
|
7534
7602
|
{
|
|
7535
7603
|
"type": "object",
|
|
7536
|
-
"description": "A variant write pins a `select` value the condition's
|
|
7604
|
+
"description": "A variant write pins a `select` value the condition's `options` do not admit — either\na value a declared vocabulary does not contain, or any value at all where the\ncondition declares no vocabulary for it to be in.\n\nOne of the two codes that report the submitted value back — `PIN_FORMAT_INVALID` is\nthe other. A resolve context value is never quoted back.\n",
|
|
7537
7605
|
"required": [
|
|
7538
7606
|
"code",
|
|
7539
7607
|
"details"
|
|
@@ -7564,7 +7632,7 @@
|
|
|
7564
7632
|
},
|
|
7565
7633
|
"options": {
|
|
7566
7634
|
"type": "array",
|
|
7567
|
-
"description": "The vocabulary *as enforced* — after the entries this deploy cannot read have\nbeen dropped, so a tenant whose `options` holds a title-only entry is told\nwhat the API actually checked against rather than what they believe they\nwrote.\n",
|
|
7635
|
+
"description": "The vocabulary *as enforced* — after the entries this deploy cannot read have\nbeen dropped, so a tenant whose `options` holds a title-only entry is told\nwhat the API actually checked against rather than what they believe they\nwrote. Empty when the condition declares no vocabulary at all, which is\nitself the reason the pin was refused; the message says which of the two\n(unconfigured, or unreadable) applies.\n",
|
|
7568
7636
|
"items": {
|
|
7569
7637
|
"type": "string"
|
|
7570
7638
|
},
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import "./chunk-YPSWSI3M.js";
|
|
2
|
+
|
|
3
|
+
// src/docs/access-token.json
|
|
4
|
+
var access_token_default = '# Access Token API\n\n- **Base URL:** `https://access-token.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/access-token](https://docs.epilot.io/api/access-token)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.accessToken.createAccessToken(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/access-token\'\n\nconst accessTokenClient = getClient()\nauthorize(accessTokenClient, () => \'<token>\')\nconst { data } = await accessTokenClient.createAccessToken(...)\n```\n\n## Operations\n\n**Access Tokens**\n- [`createAccessToken`](#createaccesstoken)\n- [`listAccessTokens`](#listaccesstokens)\n- [`revokeAccessToken`](#revokeaccesstoken)\n\n**Public**\n- [`getAccessTokenJwks`](#getaccesstokenjwks)\n- [`getAccessTokenOIDC`](#getaccesstokenoidc)\n- [`getPublicTokenJwks`](#getpublictokenjwks)\n- [`getPortalPreviewTokenJwks`](#getportalpreviewtokenjwks)\n- [`getPublicTokenOIDC`](#getpublictokenoidc)\n- [`getPortalPreviewTokenOIDC`](#getportalpreviewtokenoidc)\n- [`getContactIdentificationTokenJwks`](#getcontactidentificationtokenjwks)\n- [`getContactIdentificationTokenOIDC`](#getcontactidentificationtokenoidc)\n\n**Schemas**\n- [`AccessToken`](#accesstoken)\n- [`AccessTokenId`](#accesstokenid)\n- [`AccessTokenName`](#accesstokenname)\n- [`AccessTokenType`](#accesstokentype)\n- [`AccessTokenJourneyId`](#accesstokenjourneyid)\n- [`PortalId`](#portalid)\n- [`PortalUserId`](#portaluserid)\n- [`ContactId`](#contactid)\n- [`AllowedOperations`](#allowedoperations)\n- [`TokenParameters`](#tokenparameters)\n- [`ExpiresIn`](#expiresin)\n- [`ReadOnly`](#readonly)\n- [`Anonymize`](#anonymize)\n- [`AccessTokenParameters`](#accesstokenparameters)\n- [`JourneyTokenParameters`](#journeytokenparameters)\n- [`PortalTokenParameters`](#portaltokenparameters)\n- [`AssumeTokenParameters`](#assumetokenparameters)\n- [`AppTokenParameters`](#apptokenparameters)\n- [`PortalPreviewTokenParameters`](#portalpreviewtokenparameters)\n- [`ContactIdentificationTokenParameters`](#contactidentificationtokenparameters)\n- [`AccessTokenItem`](#accesstokenitem)\n- [`RoleId`](#roleid)\n- [`Assignments`](#assignments)\n\n### `createAccessToken`\n\n**Access Token type: `API`** (default if not specified):\n\n`POST /v1/access-tokens`\n\n```ts\nconst { data } = await client.createAccessToken(\n null,\n {\n name: \'Postman Access Token\',\n token_type: \'api\',\n assignments: [\'123:owner\'],\n expires_in: 3600,\n read_only: true,\n anonymize: true\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...",\n "id": "api_5ZugdRXasLfWBypHi93Fk",\n "created_at": "1970-01-01T00:00:00.000Z",\n "name": "Postman Access Token",\n "token_type": "api",\n "journey_id": "string",\n "portal_id": "string",\n "portal_user_id": "string",\n "contact_id": "5da0a718-c822-403d-9f5d-20d4584e0528",\n "allowed_operations": ["getContact", "getContracts"],\n "assignments": ["123:owner"],\n "read_only": true,\n "anonymize": true,\n "last_used": "2026-02-24",\n "expires_at": "2026-03-01T12:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `listAccessTokens`\n\nLists all Access Tokens for current user (by default excludes system generated tokens)\n\n`GET /v1/access-tokens`\n\n```ts\nconst { data } = await client.listAccessTokens({\n token_type: [\'...\'],\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "id": "api_5ZugdRXasLfWBypHi93Fk",\n "created_at": "1970-01-01T00:00:00.000Z",\n "name": "Postman Access Token",\n "token_type": "api",\n "journey_id": "string",\n "portal_id": "string",\n "portal_user_id": "string",\n "contact_id": "5da0a718-c822-403d-9f5d-20d4584e0528",\n "allowed_operations": ["getContact", "getContracts"],\n "assignments": ["123:owner"],\n "read_only": true,\n "anonymize": true,\n "last_used": "2026-02-24",\n "expires_at": "2026-03-01T12:00:00.000Z"\n }\n]\n```\n\n</details>\n\n---\n\n### `revokeAccessToken`\n\nRevokes an Access Token so it can\'t be used anymore.\n\n`DELETE /v1/access-tokens/{id}`\n\n```ts\nconst { data } = await client.revokeAccessToken({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "api_5ZugdRXasLfWBypHi93Fk",\n "created_at": "1970-01-01T00:00:00.000Z",\n "name": "Postman Access Token",\n "token_type": "api",\n "journey_id": "string",\n "portal_id": "string",\n "portal_user_id": "string",\n "contact_id": "5da0a718-c822-403d-9f5d-20d4584e0528",\n "allowed_operations": ["getContact", "getContracts"],\n "assignments": ["123:owner"],\n "read_only": true,\n "anonymize": true,\n "last_used": "2026-02-24",\n "expires_at": "2026-03-01T12:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `getAccessTokenJwks`\n\nGet jwks public key set to verify access tokens generated by this API\n\n`GET /v1/access-tokens/.well-known/jwks.json`\n\n```ts\nconst { data } = await client.getAccessTokenJwks()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "keys": [\n {\n "alg": "RS256",\n "e": "AQAB",\n "kid": "tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw=",\n "kty": "RSA",\n "n": "h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ",\n "use": "sig"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getAccessTokenOIDC`\n\nOpenID Connect configuration for Access Token API as identity provider\n\n`GET /v1/access-tokens/.well-known/openid-configuration`\n\n```ts\nconst { data } = await client.getAccessTokenOIDC()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "issuer": "https://access-token.sls.epilot.io/v1/access-tokens",\n "jwks_uri": "https://access-token.sls.epilot.io/v1/access-tokens/.well-known/jwks.json"\n}\n```\n\n</details>\n\n---\n\n### `getPublicTokenJwks`\n\nGet jwks public key set to verify public tokens generated by this API\n\n`GET /v1/access-tokens/public/.well-known/jwks.json`\n\n```ts\nconst { data } = await client.getPublicTokenJwks()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "keys": [\n {\n "alg": "RS256",\n "e": "AQAB",\n "kid": "tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw=",\n "kty": "RSA",\n "n": "h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ",\n "use": "sig"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getPortalPreviewTokenJwks`\n\nGet jwks public key set to verify portal preview tokens generated by this API\n\n`GET /v1/access-tokens/portal-preview/.well-known/jwks.json`\n\n```ts\nconst { data } = await client.getPortalPreviewTokenJwks()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "keys": [\n {\n "alg": "RS256",\n "e": "AQAB",\n "kid": "tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw=",\n "kty": "RSA",\n "n": "h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ",\n "use": "sig"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getPublicTokenOIDC`\n\nOpenID Connect configuration for Access Token API a a public identity provider\n\n`GET /v1/access-tokens/public/.well-known/openid-configuration`\n\n```ts\nconst { data } = await client.getPublicTokenOIDC()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "issuer": "https://access-token.sls.epilot.io/v1/access-tokens",\n "jwks_uri": "https://access-token.sls.epilot.io/v1/access-tokens/.well-known/jwks.json"\n}\n```\n\n</details>\n\n---\n\n### `getPortalPreviewTokenOIDC`\n\nOpenID Connect configuration for Access Token API a a portal preview identity provider\n\n`GET /v1/access-tokens/portal-preview/.well-known/openid-configuration`\n\n```ts\nconst { data } = await client.getPortalPreviewTokenOIDC()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "issuer": "https://access-token.sls.epilot.io/v1/access-tokens/portal-preview",\n "jwks_uri": "https://access-token.sls.epilot.io/v1/access-tokens/portal-preview/.well-known/jwks.json"\n}\n```\n\n</details>\n\n---\n\n### `getContactIdentificationTokenJwks`\n\nGet jwks public key set to verify contact identification tokens generated by this API\n\n`GET /v1/access-tokens/contact-identification/.well-known/jwks.json`\n\n```ts\nconst { data } = await client.getContactIdentificationTokenJwks()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "keys": [\n {\n "alg": "RS256",\n "e": "AQAB",\n "kid": "tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw=",\n "kty": "RSA",\n "n": "h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ",\n "use": "sig"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getContactIdentificationTokenOIDC`\n\nOpenID Connect configuration for Access Token API as a contact identification identity provider\n\n`GET /v1/access-tokens/contact-identification/.well-known/openid-configuration`\n\n```ts\nconst { data } = await client.getContactIdentificationTokenOIDC()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "issuer": "https://access-token.sls.epilot.io/v1/access-tokens/contact-identification",\n "jwks_uri": "https://access-token.sls.epilot.io/v1/access-tokens/contact-identification/.well-known/jwks.json"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `AccessToken`\n\nA JWT Access Token\n\n```ts\ntype AccessToken = string\n```\n\n### `AccessTokenId`\n\n```ts\ntype AccessTokenId = string\n```\n\n### `AccessTokenName`\n\nHuman readable name for access token\n\n```ts\ntype AccessTokenName = string\n```\n\n### `AccessTokenType`\n\nAccess token type\n\n```ts\ntype AccessTokenType = "api" | "journey" | "portal" | "assume" | "app" | "portal_preview" | "contact_identification"\n```\n\n### `AccessTokenJourneyId`\n\nJourney ID for access token type "journey"\n\n```ts\ntype AccessTokenJourneyId = string\n```\n\n### `PortalId`\n\nPortal ID for access token type "portal"\n\n```ts\ntype PortalId = string\n```\n\n### `PortalUserId`\n\nPortal User ID for access token type "portal_preview"\n\n```ts\ntype PortalUserId = string\n```\n\n### `ContactId`\n\nContact entity ID for access token type "contact_identification"\n\n```ts\ntype ContactId = string\n```\n\n### `AllowedOperations`\n\nopenapi operationIds the token may call. Enforced by the API that consumes the token, which must additionally deny any operation not on this list. Baked into the token at issue time so widening the consumer\'s own allowlist later cannot retroactively widen a token that is already in circulation.\n\n```ts\ntype AllowedOperations = string[]\n```\n\n### `TokenParameters`\n\n```ts\ntype TokenParameters = {\n name: string\n token_type?: "api"\n assignments?: string[]\n expires_in?: number | string\n read_only?: boolean\n anonymize?: boolean\n} | {\n name: string\n token_type?: "journey"\n journey_id: string\n expires_in?: number | string\n} | {\n name: string\n token_type?: "portal"\n portal_id: string\n expires_in?: number | string\n} | {\n name: string\n token_type?: "assume"\n assignments?: string[]\n read_only?: boolean\n anonymize?: boolean\n} | {\n name: string\n token_type?: "app"\n assignments?: string[]\n expires_in?: number | string\n read_only?: boolean\n anonymize?: boolean\n} | {\n name: string\n token_type?: "portal_preview"\n portal_id: string\n portal_user_id: string\n} | {\n name: string\n token_type?: "contact_identification"\n portal_id: string\n contact_id: string\n surface_id: string\n allowed_operations: string[]\n expires_in: number\n email?: string\n}\n```\n\n### `ExpiresIn`\n\n```ts\ntype ExpiresIn = number | string\n```\n\n### `ReadOnly`\n\nWhen true, the issued token may only perform read-only actions. Any action guarded by permissions that is not read-only (i.e. not a view/export/download action) is denied, regardless of the roles the token carries.\n\n```ts\ntype ReadOnly = boolean\n```\n\n### `Anonymize`\n\nForces PII anonymization on all entity data returned to this token. Cannot be disabled by the token bearer. See entity-api anonymized responses.\n\n```ts\ntype Anonymize = boolean\n```\n\n### `AccessTokenParameters`\n\n```ts\ntype AccessTokenParameters = {\n name: string\n token_type?: "api"\n assignments?: string[]\n expires_in?: number | string\n read_only?: boolean\n anonymize?: boolean\n}\n```\n\n### `JourneyTokenParameters`\n\n```ts\ntype JourneyTokenParameters = {\n name: string\n token_type?: "journey"\n journey_id: string\n expires_in?: number | string\n}\n```\n\n### `PortalTokenParameters`\n\n```ts\ntype PortalTokenParameters = {\n name: string\n token_type?: "portal"\n portal_id: string\n expires_in?: number | string\n}\n```\n\n### `AssumeTokenParameters`\n\n```ts\ntype AssumeTokenParameters = {\n name: string\n token_type?: "assume"\n assignments?: string[]\n read_only?: boolean\n anonymize?: boolean\n}\n```\n\n### `AppTokenParameters`\n\n```ts\ntype AppTokenParameters = {\n name: string\n token_type?: "app"\n assignments?: string[]\n expires_in?: number | string\n read_only?: boolean\n anonymize?: boolean\n}\n```\n\n### `PortalPreviewTokenParameters`\n\n```ts\ntype PortalPreviewTokenParameters = {\n name: string\n token_type?: "portal_preview"\n portal_id: string\n portal_user_id: string\n}\n```\n\n### `ContactIdentificationTokenParameters`\n\nA token that acts as one contact, issued after that contact was identified by a portal\'s registration identifiers rather than by logging in. Distinct from portal_preview, which impersonates an existing portal user for a 360 operator: this kind belongs to no user, is minted for an unauthenticated cal\n\n```ts\ntype ContactIdentificationTokenParameters = {\n name: string\n token_type?: "contact_identification"\n portal_id: string\n contact_id: string\n surface_id: string\n allowed_operations: string[]\n expires_in: number\n email?: string\n}\n```\n\n### `AccessTokenItem`\n\n```ts\ntype AccessTokenItem = {\n id: string\n created_at: string // date-time\n name: string\n token_type?: "api" | "journey" | "portal" | "assume" | "app" | "portal_preview" | "contact_identification"\n journey_id?: string\n portal_id?: string\n portal_user_id?: string\n contact_id?: string\n allowed_operations?: string[]\n assignments?: string[]\n read_only?: boolean\n anonymize?: boolean\n last_used?: string // date\n expires_at?: string // date-time\n}\n```\n\n### `RoleId`\n\nFormat: `<organization_id>`:`<slug>`\n\n```ts\ntype RoleId = string\n```\n\n### `Assignments`\n\nList of role ids attached to an user\n\n```ts\ntype Assignments = string[]\n```\n';
|
|
5
|
+
export {
|
|
6
|
+
access_token_default as default
|
|
7
|
+
};
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
|
|
2
|
+
|
|
3
|
+
// src/docs/access-token.json
|
|
4
|
+
var access_token_default = '# Access Token API\n\n- **Base URL:** `https://access-token.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/access-token](https://docs.epilot.io/api/access-token)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.accessToken.createAccessToken(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/access-token\'\n\nconst accessTokenClient = getClient()\nauthorize(accessTokenClient, () => \'<token>\')\nconst { data } = await accessTokenClient.createAccessToken(...)\n```\n\n## Operations\n\n**Access Tokens**\n- [`createAccessToken`](#createaccesstoken)\n- [`listAccessTokens`](#listaccesstokens)\n- [`revokeAccessToken`](#revokeaccesstoken)\n\n**Public**\n- [`getAccessTokenJwks`](#getaccesstokenjwks)\n- [`getAccessTokenOIDC`](#getaccesstokenoidc)\n- [`getPublicTokenJwks`](#getpublictokenjwks)\n- [`getPortalPreviewTokenJwks`](#getportalpreviewtokenjwks)\n- [`getPublicTokenOIDC`](#getpublictokenoidc)\n- [`getPortalPreviewTokenOIDC`](#getportalpreviewtokenoidc)\n- [`getContactIdentificationTokenJwks`](#getcontactidentificationtokenjwks)\n- [`getContactIdentificationTokenOIDC`](#getcontactidentificationtokenoidc)\n\n**Schemas**\n- [`AccessToken`](#accesstoken)\n- [`AccessTokenId`](#accesstokenid)\n- [`AccessTokenName`](#accesstokenname)\n- [`AccessTokenType`](#accesstokentype)\n- [`AccessTokenJourneyId`](#accesstokenjourneyid)\n- [`PortalId`](#portalid)\n- [`PortalUserId`](#portaluserid)\n- [`ContactId`](#contactid)\n- [`AllowedOperations`](#allowedoperations)\n- [`TokenParameters`](#tokenparameters)\n- [`ExpiresIn`](#expiresin)\n- [`ReadOnly`](#readonly)\n- [`Anonymize`](#anonymize)\n- [`AccessTokenParameters`](#accesstokenparameters)\n- [`JourneyTokenParameters`](#journeytokenparameters)\n- [`PortalTokenParameters`](#portaltokenparameters)\n- [`AssumeTokenParameters`](#assumetokenparameters)\n- [`AppTokenParameters`](#apptokenparameters)\n- [`PortalPreviewTokenParameters`](#portalpreviewtokenparameters)\n- [`ContactIdentificationTokenParameters`](#contactidentificationtokenparameters)\n- [`AccessTokenItem`](#accesstokenitem)\n- [`RoleId`](#roleid)\n- [`Assignments`](#assignments)\n\n### `createAccessToken`\n\n**Access Token type: `API`** (default if not specified):\n\n`POST /v1/access-tokens`\n\n```ts\nconst { data } = await client.createAccessToken(\n null,\n {\n name: \'Postman Access Token\',\n token_type: \'api\',\n assignments: [\'123:owner\'],\n expires_in: 3600,\n read_only: true,\n anonymize: true\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...",\n "id": "api_5ZugdRXasLfWBypHi93Fk",\n "created_at": "1970-01-01T00:00:00.000Z",\n "name": "Postman Access Token",\n "token_type": "api",\n "journey_id": "string",\n "portal_id": "string",\n "portal_user_id": "string",\n "contact_id": "5da0a718-c822-403d-9f5d-20d4584e0528",\n "allowed_operations": ["getContact", "getContracts"],\n "assignments": ["123:owner"],\n "read_only": true,\n "anonymize": true,\n "last_used": "2026-02-24",\n "expires_at": "2026-03-01T12:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `listAccessTokens`\n\nLists all Access Tokens for current user (by default excludes system generated tokens)\n\n`GET /v1/access-tokens`\n\n```ts\nconst { data } = await client.listAccessTokens({\n token_type: [\'...\'],\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "id": "api_5ZugdRXasLfWBypHi93Fk",\n "created_at": "1970-01-01T00:00:00.000Z",\n "name": "Postman Access Token",\n "token_type": "api",\n "journey_id": "string",\n "portal_id": "string",\n "portal_user_id": "string",\n "contact_id": "5da0a718-c822-403d-9f5d-20d4584e0528",\n "allowed_operations": ["getContact", "getContracts"],\n "assignments": ["123:owner"],\n "read_only": true,\n "anonymize": true,\n "last_used": "2026-02-24",\n "expires_at": "2026-03-01T12:00:00.000Z"\n }\n]\n```\n\n</details>\n\n---\n\n### `revokeAccessToken`\n\nRevokes an Access Token so it can\'t be used anymore.\n\n`DELETE /v1/access-tokens/{id}`\n\n```ts\nconst { data } = await client.revokeAccessToken({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "api_5ZugdRXasLfWBypHi93Fk",\n "created_at": "1970-01-01T00:00:00.000Z",\n "name": "Postman Access Token",\n "token_type": "api",\n "journey_id": "string",\n "portal_id": "string",\n "portal_user_id": "string",\n "contact_id": "5da0a718-c822-403d-9f5d-20d4584e0528",\n "allowed_operations": ["getContact", "getContracts"],\n "assignments": ["123:owner"],\n "read_only": true,\n "anonymize": true,\n "last_used": "2026-02-24",\n "expires_at": "2026-03-01T12:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `getAccessTokenJwks`\n\nGet jwks public key set to verify access tokens generated by this API\n\n`GET /v1/access-tokens/.well-known/jwks.json`\n\n```ts\nconst { data } = await client.getAccessTokenJwks()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "keys": [\n {\n "alg": "RS256",\n "e": "AQAB",\n "kid": "tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw=",\n "kty": "RSA",\n "n": "h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ",\n "use": "sig"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getAccessTokenOIDC`\n\nOpenID Connect configuration for Access Token API as identity provider\n\n`GET /v1/access-tokens/.well-known/openid-configuration`\n\n```ts\nconst { data } = await client.getAccessTokenOIDC()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "issuer": "https://access-token.sls.epilot.io/v1/access-tokens",\n "jwks_uri": "https://access-token.sls.epilot.io/v1/access-tokens/.well-known/jwks.json"\n}\n```\n\n</details>\n\n---\n\n### `getPublicTokenJwks`\n\nGet jwks public key set to verify public tokens generated by this API\n\n`GET /v1/access-tokens/public/.well-known/jwks.json`\n\n```ts\nconst { data } = await client.getPublicTokenJwks()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "keys": [\n {\n "alg": "RS256",\n "e": "AQAB",\n "kid": "tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw=",\n "kty": "RSA",\n "n": "h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ",\n "use": "sig"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getPortalPreviewTokenJwks`\n\nGet jwks public key set to verify portal preview tokens generated by this API\n\n`GET /v1/access-tokens/portal-preview/.well-known/jwks.json`\n\n```ts\nconst { data } = await client.getPortalPreviewTokenJwks()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "keys": [\n {\n "alg": "RS256",\n "e": "AQAB",\n "kid": "tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw=",\n "kty": "RSA",\n "n": "h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ",\n "use": "sig"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getPublicTokenOIDC`\n\nOpenID Connect configuration for Access Token API a a public identity provider\n\n`GET /v1/access-tokens/public/.well-known/openid-configuration`\n\n```ts\nconst { data } = await client.getPublicTokenOIDC()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "issuer": "https://access-token.sls.epilot.io/v1/access-tokens",\n "jwks_uri": "https://access-token.sls.epilot.io/v1/access-tokens/.well-known/jwks.json"\n}\n```\n\n</details>\n\n---\n\n### `getPortalPreviewTokenOIDC`\n\nOpenID Connect configuration for Access Token API a a portal preview identity provider\n\n`GET /v1/access-tokens/portal-preview/.well-known/openid-configuration`\n\n```ts\nconst { data } = await client.getPortalPreviewTokenOIDC()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "issuer": "https://access-token.sls.epilot.io/v1/access-tokens/portal-preview",\n "jwks_uri": "https://access-token.sls.epilot.io/v1/access-tokens/portal-preview/.well-known/jwks.json"\n}\n```\n\n</details>\n\n---\n\n### `getContactIdentificationTokenJwks`\n\nGet jwks public key set to verify contact identification tokens generated by this API\n\n`GET /v1/access-tokens/contact-identification/.well-known/jwks.json`\n\n```ts\nconst { data } = await client.getContactIdentificationTokenJwks()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "keys": [\n {\n "alg": "RS256",\n "e": "AQAB",\n "kid": "tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw=",\n "kty": "RSA",\n "n": "h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ",\n "use": "sig"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getContactIdentificationTokenOIDC`\n\nOpenID Connect configuration for Access Token API as a contact identification identity provider\n\n`GET /v1/access-tokens/contact-identification/.well-known/openid-configuration`\n\n```ts\nconst { data } = await client.getContactIdentificationTokenOIDC()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "issuer": "https://access-token.sls.epilot.io/v1/access-tokens/contact-identification",\n "jwks_uri": "https://access-token.sls.epilot.io/v1/access-tokens/contact-identification/.well-known/jwks.json"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `AccessToken`\n\nA JWT Access Token\n\n```ts\ntype AccessToken = string\n```\n\n### `AccessTokenId`\n\n```ts\ntype AccessTokenId = string\n```\n\n### `AccessTokenName`\n\nHuman readable name for access token\n\n```ts\ntype AccessTokenName = string\n```\n\n### `AccessTokenType`\n\nAccess token type\n\n```ts\ntype AccessTokenType = "api" | "journey" | "portal" | "assume" | "app" | "portal_preview" | "contact_identification"\n```\n\n### `AccessTokenJourneyId`\n\nJourney ID for access token type "journey"\n\n```ts\ntype AccessTokenJourneyId = string\n```\n\n### `PortalId`\n\nPortal ID for access token type "portal"\n\n```ts\ntype PortalId = string\n```\n\n### `PortalUserId`\n\nPortal User ID for access token type "portal_preview"\n\n```ts\ntype PortalUserId = string\n```\n\n### `ContactId`\n\nContact entity ID for access token type "contact_identification"\n\n```ts\ntype ContactId = string\n```\n\n### `AllowedOperations`\n\nopenapi operationIds the token may call. Enforced by the API that consumes the token, which must additionally deny any operation not on this list. Baked into the token at issue time so widening the consumer\'s own allowlist later cannot retroactively widen a token that is already in circulation.\n\n```ts\ntype AllowedOperations = string[]\n```\n\n### `TokenParameters`\n\n```ts\ntype TokenParameters = {\n name: string\n token_type?: "api"\n assignments?: string[]\n expires_in?: number | string\n read_only?: boolean\n anonymize?: boolean\n} | {\n name: string\n token_type?: "journey"\n journey_id: string\n expires_in?: number | string\n} | {\n name: string\n token_type?: "portal"\n portal_id: string\n expires_in?: number | string\n} | {\n name: string\n token_type?: "assume"\n assignments?: string[]\n read_only?: boolean\n anonymize?: boolean\n} | {\n name: string\n token_type?: "app"\n assignments?: string[]\n expires_in?: number | string\n read_only?: boolean\n anonymize?: boolean\n} | {\n name: string\n token_type?: "portal_preview"\n portal_id: string\n portal_user_id: string\n} | {\n name: string\n token_type?: "contact_identification"\n portal_id: string\n contact_id: string\n surface_id: string\n allowed_operations: string[]\n expires_in: number\n email?: string\n}\n```\n\n### `ExpiresIn`\n\n```ts\ntype ExpiresIn = number | string\n```\n\n### `ReadOnly`\n\nWhen true, the issued token may only perform read-only actions. Any action guarded by permissions that is not read-only (i.e. not a view/export/download action) is denied, regardless of the roles the token carries.\n\n```ts\ntype ReadOnly = boolean\n```\n\n### `Anonymize`\n\nForces PII anonymization on all entity data returned to this token. Cannot be disabled by the token bearer. See entity-api anonymized responses.\n\n```ts\ntype Anonymize = boolean\n```\n\n### `AccessTokenParameters`\n\n```ts\ntype AccessTokenParameters = {\n name: string\n token_type?: "api"\n assignments?: string[]\n expires_in?: number | string\n read_only?: boolean\n anonymize?: boolean\n}\n```\n\n### `JourneyTokenParameters`\n\n```ts\ntype JourneyTokenParameters = {\n name: string\n token_type?: "journey"\n journey_id: string\n expires_in?: number | string\n}\n```\n\n### `PortalTokenParameters`\n\n```ts\ntype PortalTokenParameters = {\n name: string\n token_type?: "portal"\n portal_id: string\n expires_in?: number | string\n}\n```\n\n### `AssumeTokenParameters`\n\n```ts\ntype AssumeTokenParameters = {\n name: string\n token_type?: "assume"\n assignments?: string[]\n read_only?: boolean\n anonymize?: boolean\n}\n```\n\n### `AppTokenParameters`\n\n```ts\ntype AppTokenParameters = {\n name: string\n token_type?: "app"\n assignments?: string[]\n expires_in?: number | string\n read_only?: boolean\n anonymize?: boolean\n}\n```\n\n### `PortalPreviewTokenParameters`\n\n```ts\ntype PortalPreviewTokenParameters = {\n name: string\n token_type?: "portal_preview"\n portal_id: string\n portal_user_id: string\n}\n```\n\n### `ContactIdentificationTokenParameters`\n\nA token that acts as one contact, issued after that contact was identified by a portal\'s registration identifiers rather than by logging in. Distinct from portal_preview, which impersonates an existing portal user for a 360 operator: this kind belongs to no user, is minted for an unauthenticated cal\n\n```ts\ntype ContactIdentificationTokenParameters = {\n name: string\n token_type?: "contact_identification"\n portal_id: string\n contact_id: string\n surface_id: string\n allowed_operations: string[]\n expires_in: number\n email?: string\n}\n```\n\n### `AccessTokenItem`\n\n```ts\ntype AccessTokenItem = {\n id: string\n created_at: string // date-time\n name: string\n token_type?: "api" | "journey" | "portal" | "assume" | "app" | "portal_preview" | "contact_identification"\n journey_id?: string\n portal_id?: string\n portal_user_id?: string\n contact_id?: string\n allowed_operations?: string[]\n assignments?: string[]\n read_only?: boolean\n anonymize?: boolean\n last_used?: string // date\n expires_at?: string // date-time\n}\n```\n\n### `RoleId`\n\nFormat: `<organization_id>`:`<slug>`\n\n```ts\ntype RoleId = string\n```\n\n### `Assignments`\n\nList of role ids attached to an user\n\n```ts\ntype Assignments = string[]\n```\n';
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
exports.default = access_token_default;
|
|
@@ -44,7 +44,6 @@ declare namespace Components {
|
|
|
44
44
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
45
45
|
*/
|
|
46
46
|
ContactId;
|
|
47
|
-
origin?: /* Portal origin the token assumes, so the bearer is permission-masked the same way the corresponding portal role is. */ PortalOrigin;
|
|
48
47
|
allowed_operations?: /**
|
|
49
48
|
* openapi operationIds the token may call. Enforced by the API that consumes the token, which must additionally deny any operation not on this list. Baked into the token at issue time so widening the consumer's own allowlist later cannot retroactively widen a token that is already in circulation.
|
|
50
49
|
* example:
|
|
@@ -218,7 +217,6 @@ declare namespace Components {
|
|
|
218
217
|
* website-journeys
|
|
219
218
|
*/
|
|
220
219
|
surface_id: string;
|
|
221
|
-
origin?: /* Portal origin the token assumes, so the bearer is permission-masked the same way the corresponding portal role is. */ PortalOrigin;
|
|
222
220
|
allowed_operations: /**
|
|
223
221
|
* openapi operationIds the token may call. Enforced by the API that consumes the token, which must additionally deny any operation not on this list. Baked into the token at issue time so widening the consumer's own allowlist later cannot retroactively widen a token that is already in circulation.
|
|
224
222
|
* example:
|
|
@@ -255,10 +253,6 @@ declare namespace Components {
|
|
|
255
253
|
* Portal ID for access token type "portal"
|
|
256
254
|
*/
|
|
257
255
|
export type PortalId = string;
|
|
258
|
-
/**
|
|
259
|
-
* Portal origin the token assumes, so the bearer is permission-masked the same way the corresponding portal role is.
|
|
260
|
-
*/
|
|
261
|
-
export type PortalOrigin = "END_CUSTOMER_PORTAL" | "INSTALLER_PORTAL";
|
|
262
256
|
export interface PortalPreviewTokenParameters {
|
|
263
257
|
name: /**
|
|
264
258
|
* Human readable name for access token
|
|
@@ -338,7 +332,6 @@ declare namespace Paths {
|
|
|
338
332
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
339
333
|
*/
|
|
340
334
|
Components.Schemas.ContactId;
|
|
341
|
-
origin?: /* Portal origin the token assumes, so the bearer is permission-masked the same way the corresponding portal role is. */ Components.Schemas.PortalOrigin;
|
|
342
335
|
allowed_operations?: /**
|
|
343
336
|
* openapi operationIds the token may call. Enforced by the API that consumes the token, which must additionally deny any operation not on this list. Baked into the token at issue time so widening the consumer's own allowlist later cannot retroactively widen a token that is already in circulation.
|
|
344
337
|
* example:
|
|
@@ -956,7 +949,6 @@ type ContactIdentificationTokenParameters = Components.Schemas.ContactIdentifica
|
|
|
956
949
|
type ExpiresIn = Components.Schemas.ExpiresIn;
|
|
957
950
|
type JourneyTokenParameters = Components.Schemas.JourneyTokenParameters;
|
|
958
951
|
type PortalId = Components.Schemas.PortalId;
|
|
959
|
-
type PortalOrigin = Components.Schemas.PortalOrigin;
|
|
960
952
|
type PortalPreviewTokenParameters = Components.Schemas.PortalPreviewTokenParameters;
|
|
961
953
|
type PortalTokenParameters = Components.Schemas.PortalTokenParameters;
|
|
962
954
|
type PortalUserId = Components.Schemas.PortalUserId;
|
|
@@ -964,4 +956,4 @@ type ReadOnly = Components.Schemas.ReadOnly;
|
|
|
964
956
|
type RoleId = Components.Schemas.RoleId;
|
|
965
957
|
type TokenParameters = Components.Schemas.TokenParameters;
|
|
966
958
|
|
|
967
|
-
export { type AccessToken as A, type Client as C, type ExpiresIn as E, type JourneyTokenParameters as J, type OperationMethods as O, Paths as P, type ReadOnly as R, type TokenParameters as T, Components as a, type PathsDictionary as b, type AccessTokenId as c, type AccessTokenItem as d, type AccessTokenJourneyId as e, type AccessTokenName as f, type AccessTokenParameters as g, type AccessTokenType as h, type AllowedOperations as i, type Anonymize as j, type AppTokenParameters as k, type Assignments as l, type AssumeTokenParameters as m, type ContactId as n, type ContactIdentificationTokenParameters as o, type PortalId as p, type
|
|
959
|
+
export { type AccessToken as A, type Client as C, type ExpiresIn as E, type JourneyTokenParameters as J, type OperationMethods as O, Paths as P, type ReadOnly as R, type TokenParameters as T, Components as a, type PathsDictionary as b, type AccessTokenId as c, type AccessTokenItem as d, type AccessTokenJourneyId as e, type AccessTokenName as f, type AccessTokenParameters as g, type AccessTokenType as h, type AllowedOperations as i, type Anonymize as j, type AppTokenParameters as k, type Assignments as l, type AssumeTokenParameters as m, type ContactId as n, type ContactIdentificationTokenParameters as o, type PortalId as p, type PortalPreviewTokenParameters as q, type PortalTokenParameters as r, type PortalUserId as s, type RoleId as t };
|
|
@@ -44,7 +44,6 @@ declare namespace Components {
|
|
|
44
44
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
45
45
|
*/
|
|
46
46
|
ContactId;
|
|
47
|
-
origin?: /* Portal origin the token assumes, so the bearer is permission-masked the same way the corresponding portal role is. */ PortalOrigin;
|
|
48
47
|
allowed_operations?: /**
|
|
49
48
|
* openapi operationIds the token may call. Enforced by the API that consumes the token, which must additionally deny any operation not on this list. Baked into the token at issue time so widening the consumer's own allowlist later cannot retroactively widen a token that is already in circulation.
|
|
50
49
|
* example:
|
|
@@ -218,7 +217,6 @@ declare namespace Components {
|
|
|
218
217
|
* website-journeys
|
|
219
218
|
*/
|
|
220
219
|
surface_id: string;
|
|
221
|
-
origin?: /* Portal origin the token assumes, so the bearer is permission-masked the same way the corresponding portal role is. */ PortalOrigin;
|
|
222
220
|
allowed_operations: /**
|
|
223
221
|
* openapi operationIds the token may call. Enforced by the API that consumes the token, which must additionally deny any operation not on this list. Baked into the token at issue time so widening the consumer's own allowlist later cannot retroactively widen a token that is already in circulation.
|
|
224
222
|
* example:
|
|
@@ -255,10 +253,6 @@ declare namespace Components {
|
|
|
255
253
|
* Portal ID for access token type "portal"
|
|
256
254
|
*/
|
|
257
255
|
export type PortalId = string;
|
|
258
|
-
/**
|
|
259
|
-
* Portal origin the token assumes, so the bearer is permission-masked the same way the corresponding portal role is.
|
|
260
|
-
*/
|
|
261
|
-
export type PortalOrigin = "END_CUSTOMER_PORTAL" | "INSTALLER_PORTAL";
|
|
262
256
|
export interface PortalPreviewTokenParameters {
|
|
263
257
|
name: /**
|
|
264
258
|
* Human readable name for access token
|
|
@@ -338,7 +332,6 @@ declare namespace Paths {
|
|
|
338
332
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
339
333
|
*/
|
|
340
334
|
Components.Schemas.ContactId;
|
|
341
|
-
origin?: /* Portal origin the token assumes, so the bearer is permission-masked the same way the corresponding portal role is. */ Components.Schemas.PortalOrigin;
|
|
342
335
|
allowed_operations?: /**
|
|
343
336
|
* openapi operationIds the token may call. Enforced by the API that consumes the token, which must additionally deny any operation not on this list. Baked into the token at issue time so widening the consumer's own allowlist later cannot retroactively widen a token that is already in circulation.
|
|
344
337
|
* example:
|
|
@@ -956,7 +949,6 @@ type ContactIdentificationTokenParameters = Components.Schemas.ContactIdentifica
|
|
|
956
949
|
type ExpiresIn = Components.Schemas.ExpiresIn;
|
|
957
950
|
type JourneyTokenParameters = Components.Schemas.JourneyTokenParameters;
|
|
958
951
|
type PortalId = Components.Schemas.PortalId;
|
|
959
|
-
type PortalOrigin = Components.Schemas.PortalOrigin;
|
|
960
952
|
type PortalPreviewTokenParameters = Components.Schemas.PortalPreviewTokenParameters;
|
|
961
953
|
type PortalTokenParameters = Components.Schemas.PortalTokenParameters;
|
|
962
954
|
type PortalUserId = Components.Schemas.PortalUserId;
|
|
@@ -964,4 +956,4 @@ type ReadOnly = Components.Schemas.ReadOnly;
|
|
|
964
956
|
type RoleId = Components.Schemas.RoleId;
|
|
965
957
|
type TokenParameters = Components.Schemas.TokenParameters;
|
|
966
958
|
|
|
967
|
-
export { type AccessToken as A, type Client as C, type ExpiresIn as E, type JourneyTokenParameters as J, type OperationMethods as O, Paths as P, type ReadOnly as R, type TokenParameters as T, Components as a, type PathsDictionary as b, type AccessTokenId as c, type AccessTokenItem as d, type AccessTokenJourneyId as e, type AccessTokenName as f, type AccessTokenParameters as g, type AccessTokenType as h, type AllowedOperations as i, type Anonymize as j, type AppTokenParameters as k, type Assignments as l, type AssumeTokenParameters as m, type ContactId as n, type ContactIdentificationTokenParameters as o, type PortalId as p, type
|
|
959
|
+
export { type AccessToken as A, type Client as C, type ExpiresIn as E, type JourneyTokenParameters as J, type OperationMethods as O, Paths as P, type ReadOnly as R, type TokenParameters as T, Components as a, type PathsDictionary as b, type AccessTokenId as c, type AccessTokenItem as d, type AccessTokenJourneyId as e, type AccessTokenName as f, type AccessTokenParameters as g, type AccessTokenType as h, type AllowedOperations as i, type Anonymize as j, type AppTokenParameters as k, type Assignments as l, type AssumeTokenParameters as m, type ContactId as n, type ContactIdentificationTokenParameters as o, type PortalId as p, type PortalPreviewTokenParameters as q, type PortalTokenParameters as r, type PortalUserId as s, type RoleId as t };
|
|
@@ -6,25 +6,25 @@ var _chunkZMBA3WV4cjs = require('../chunk-ZMBA3WV4.cjs');
|
|
|
6
6
|
|
|
7
7
|
|
|
8
8
|
|
|
9
|
-
var
|
|
9
|
+
var _chunkOZHARSW5cjs = require('../chunk-OZHARSW5.cjs');
|
|
10
10
|
require('../chunk-NJK5F5TF.cjs');
|
|
11
11
|
|
|
12
12
|
// src/apis/access-token.ts
|
|
13
13
|
var loadDefinition = () => {
|
|
14
14
|
const mod = _chunkZMBA3WV4cjs.require_access_token_runtime.call(void 0, );
|
|
15
|
-
return
|
|
15
|
+
return _chunkOZHARSW5cjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
|
|
16
16
|
};
|
|
17
17
|
var _instance = null;
|
|
18
18
|
var resolve = () => {
|
|
19
19
|
if (!_instance) {
|
|
20
20
|
const def = loadDefinition();
|
|
21
|
-
_instance =
|
|
21
|
+
_instance = _chunkOZHARSW5cjs.createApiClient.call(void 0, { definition: def, apiName: "accessToken" });
|
|
22
22
|
}
|
|
23
23
|
return _instance;
|
|
24
24
|
};
|
|
25
|
-
var _handle =
|
|
25
|
+
var _handle = _chunkOZHARSW5cjs.createApiHandle.call(void 0, {
|
|
26
26
|
resolveClient: resolve,
|
|
27
|
-
createClient: () =>
|
|
27
|
+
createClient: () => _chunkOZHARSW5cjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "accessToken" }),
|
|
28
28
|
apiName: "accessToken"
|
|
29
29
|
});
|
|
30
30
|
var getClient = _handle.getClient;
|
|
@@ -35,4 +35,4 @@ var accessToken = _handle;
|
|
|
35
35
|
|
|
36
36
|
|
|
37
37
|
|
|
38
|
-
exports.accessToken = accessToken; exports.authorize =
|
|
38
|
+
exports.accessToken = accessToken; exports.authorize = _chunkOZHARSW5cjs.authorize; exports.createClient = createClient; exports.getClient = getClient;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { A as ApiHandle } from '../types-ChU9Acbv.cjs';
|
|
2
2
|
export { T as TokenArg, a as authorize } from '../types-ChU9Acbv.cjs';
|
|
3
|
-
import { C as Client } from '../access-token.d-
|
|
4
|
-
export { A as AccessToken, c as AccessTokenId, d as AccessTokenItem, e as AccessTokenJourneyId, f as AccessTokenName, g as AccessTokenParameters, h as AccessTokenType, i as AllowedOperations, j as Anonymize, k as AppTokenParameters, l as Assignments, m as AssumeTokenParameters, a as Components, n as ContactId, o as ContactIdentificationTokenParameters, E as ExpiresIn, J as JourneyTokenParameters, O as OperationMethods, P as Paths, b as PathsDictionary, p as PortalId, q as
|
|
3
|
+
import { C as Client } from '../access-token.d-Yy-yrft_.cjs';
|
|
4
|
+
export { A as AccessToken, c as AccessTokenId, d as AccessTokenItem, e as AccessTokenJourneyId, f as AccessTokenName, g as AccessTokenParameters, h as AccessTokenType, i as AllowedOperations, j as Anonymize, k as AppTokenParameters, l as Assignments, m as AssumeTokenParameters, a as Components, n as ContactId, o as ContactIdentificationTokenParameters, E as ExpiresIn, J as JourneyTokenParameters, O as OperationMethods, P as Paths, b as PathsDictionary, p as PortalId, q as PortalPreviewTokenParameters, r as PortalTokenParameters, s as PortalUserId, R as ReadOnly, t as RoleId, T as TokenParameters } from '../access-token.d-Yy-yrft_.cjs';
|
|
5
5
|
export { OpenAPIClient } from 'openapi-client-axios';
|
|
6
6
|
import 'axios';
|
|
7
7
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { A as ApiHandle } from '../types-ChU9Acbv.js';
|
|
2
2
|
export { T as TokenArg, a as authorize } from '../types-ChU9Acbv.js';
|
|
3
|
-
import { C as Client } from '../access-token.d-
|
|
4
|
-
export { A as AccessToken, c as AccessTokenId, d as AccessTokenItem, e as AccessTokenJourneyId, f as AccessTokenName, g as AccessTokenParameters, h as AccessTokenType, i as AllowedOperations, j as Anonymize, k as AppTokenParameters, l as Assignments, m as AssumeTokenParameters, a as Components, n as ContactId, o as ContactIdentificationTokenParameters, E as ExpiresIn, J as JourneyTokenParameters, O as OperationMethods, P as Paths, b as PathsDictionary, p as PortalId, q as
|
|
3
|
+
import { C as Client } from '../access-token.d-Yy-yrft_.js';
|
|
4
|
+
export { A as AccessToken, c as AccessTokenId, d as AccessTokenItem, e as AccessTokenJourneyId, f as AccessTokenName, g as AccessTokenParameters, h as AccessTokenType, i as AllowedOperations, j as Anonymize, k as AppTokenParameters, l as Assignments, m as AssumeTokenParameters, a as Components, n as ContactId, o as ContactIdentificationTokenParameters, E as ExpiresIn, J as JourneyTokenParameters, O as OperationMethods, P as Paths, b as PathsDictionary, p as PortalId, q as PortalPreviewTokenParameters, r as PortalTokenParameters, s as PortalUserId, R as ReadOnly, t as RoleId, T as TokenParameters } from '../access-token.d-Yy-yrft_.js';
|
|
5
5
|
export { OpenAPIClient } from 'openapi-client-axios';
|
|
6
6
|
import 'axios';
|
|
7
7
|
|
|
@@ -6,25 +6,25 @@ var _chunkLKRBFBFNcjs = require('../chunk-LKRBFBFN.cjs');
|
|
|
6
6
|
|
|
7
7
|
|
|
8
8
|
|
|
9
|
-
var
|
|
9
|
+
var _chunkOZHARSW5cjs = require('../chunk-OZHARSW5.cjs');
|
|
10
10
|
require('../chunk-NJK5F5TF.cjs');
|
|
11
11
|
|
|
12
12
|
// src/apis/address-suggestions.ts
|
|
13
13
|
var loadDefinition = () => {
|
|
14
14
|
const mod = _chunkLKRBFBFNcjs.require_address_suggestions_runtime.call(void 0, );
|
|
15
|
-
return
|
|
15
|
+
return _chunkOZHARSW5cjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
|
|
16
16
|
};
|
|
17
17
|
var _instance = null;
|
|
18
18
|
var resolve = () => {
|
|
19
19
|
if (!_instance) {
|
|
20
20
|
const def = loadDefinition();
|
|
21
|
-
_instance =
|
|
21
|
+
_instance = _chunkOZHARSW5cjs.createApiClient.call(void 0, { definition: def, apiName: "addressSuggestions" });
|
|
22
22
|
}
|
|
23
23
|
return _instance;
|
|
24
24
|
};
|
|
25
|
-
var _handle =
|
|
25
|
+
var _handle = _chunkOZHARSW5cjs.createApiHandle.call(void 0, {
|
|
26
26
|
resolveClient: resolve,
|
|
27
|
-
createClient: () =>
|
|
27
|
+
createClient: () => _chunkOZHARSW5cjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "addressSuggestions" }),
|
|
28
28
|
apiName: "addressSuggestions"
|
|
29
29
|
});
|
|
30
30
|
var getClient = _handle.getClient;
|
|
@@ -35,4 +35,4 @@ var addressSuggestions = _handle;
|
|
|
35
35
|
|
|
36
36
|
|
|
37
37
|
|
|
38
|
-
exports.addressSuggestions = addressSuggestions; exports.authorize =
|
|
38
|
+
exports.addressSuggestions = addressSuggestions; exports.authorize = _chunkOZHARSW5cjs.authorize; exports.createClient = createClient; exports.getClient = getClient;
|
package/dist/apis/address.cjs
CHANGED
|
@@ -6,25 +6,25 @@ var _chunkT67ZXTVGcjs = require('../chunk-T67ZXTVG.cjs');
|
|
|
6
6
|
|
|
7
7
|
|
|
8
8
|
|
|
9
|
-
var
|
|
9
|
+
var _chunkOZHARSW5cjs = require('../chunk-OZHARSW5.cjs');
|
|
10
10
|
require('../chunk-NJK5F5TF.cjs');
|
|
11
11
|
|
|
12
12
|
// src/apis/address.ts
|
|
13
13
|
var loadDefinition = () => {
|
|
14
14
|
const mod = _chunkT67ZXTVGcjs.require_address_runtime.call(void 0, );
|
|
15
|
-
return
|
|
15
|
+
return _chunkOZHARSW5cjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
|
|
16
16
|
};
|
|
17
17
|
var _instance = null;
|
|
18
18
|
var resolve = () => {
|
|
19
19
|
if (!_instance) {
|
|
20
20
|
const def = loadDefinition();
|
|
21
|
-
_instance =
|
|
21
|
+
_instance = _chunkOZHARSW5cjs.createApiClient.call(void 0, { definition: def, apiName: "address" });
|
|
22
22
|
}
|
|
23
23
|
return _instance;
|
|
24
24
|
};
|
|
25
|
-
var _handle =
|
|
25
|
+
var _handle = _chunkOZHARSW5cjs.createApiHandle.call(void 0, {
|
|
26
26
|
resolveClient: resolve,
|
|
27
|
-
createClient: () =>
|
|
27
|
+
createClient: () => _chunkOZHARSW5cjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "address" }),
|
|
28
28
|
apiName: "address"
|
|
29
29
|
});
|
|
30
30
|
var getClient = _handle.getClient;
|
|
@@ -35,4 +35,4 @@ var address = _handle;
|
|
|
35
35
|
|
|
36
36
|
|
|
37
37
|
|
|
38
|
-
exports.address = address; exports.authorize =
|
|
38
|
+
exports.address = address; exports.authorize = _chunkOZHARSW5cjs.authorize; exports.createClient = createClient; exports.getClient = getClient;
|