{ "typeDocModel": { "id": 18635, "name": "@wix/tags_tags", "variant": "project", "kind": 1, "flags": {}, "children": [ { "id": 18677, "name": "TagExposure", "variant": "declaration", "kind": 8, "flags": {}, "children": [ { "id": 18679, "name": "PRIVATE", "variant": "declaration", "kind": 16, "flags": {}, "type": { "type": "literal", "value": "PRIVATE" } }, { "id": 18678, "name": "UNKNOWN", "variant": "declaration", "kind": 16, "flags": {}, "type": { "type": "literal", "value": "UNKNOWN" } } ], "groups": [ { "title": "Enumeration Members", "children": [ 18679, 18678 ] } ] }, { "id": 18743, "name": "WebhookIdentityType", "variant": "declaration", "kind": 8, "flags": {}, "children": [ { "id": 18745, "name": "ANONYMOUS_VISITOR", "variant": "declaration", "kind": 16, "flags": {}, "type": { "type": "literal", "value": "ANONYMOUS_VISITOR" } }, { "id": 18748, "name": "APP", "variant": "declaration", "kind": 16, "flags": {}, "type": { "type": "literal", "value": "APP" } }, { "id": 18746, "name": "MEMBER", "variant": "declaration", "kind": 16, "flags": {}, "type": { "type": "literal", "value": "MEMBER" } }, { "id": 18744, "name": "UNKNOWN", "variant": "declaration", "kind": 16, "flags": {}, "type": { "type": "literal", "value": "UNKNOWN" } }, { "id": 18747, "name": "WIX_USER", "variant": "declaration", "kind": 16, "flags": {}, "type": { "type": "literal", "value": "WIX_USER" } } ], "groups": [ { "title": "Enumeration Members", "children": [ 18745, 18748, 18746, 18744, 18747 ] } ] }, { "id": 18725, "name": "ActionEvent", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18726, "name": "body", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 18726 ] } ] }, { "id": 18778, "name": "BaseEventMetadata", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18780, "name": "eventType", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Event type." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 18781, "name": "identity", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The identification type and identity data." } ] }, "type": { "type": "reference", "target": 18732, "name": "IdentificationData", "package": "@wix/tags_tags" } }, { "id": 18779, "name": "instanceId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "App instance ID." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Properties", "children": [ 18780, 18781, 18779 ] } ], "extendedBy": [ { "type": "reference", "target": 18782, "name": "EventMetadata" } ] }, { "id": 18749, "name": "CreateTagForAccountRequest", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18750, "name": "tag", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The tag to be created." } ] }, "type": { "type": "reference", "target": 18670, "name": "Tag", "package": "@wix/tags_tags" } } ], "groups": [ { "title": "Properties", "children": [ 18750 ] } ] }, { "id": 18751, "name": "CreateTagForAccountResponse", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18752, "name": "tag", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The created tag." } ] }, "type": { "type": "reference", "target": 18670, "name": "Tag", "package": "@wix/tags_tags" } } ], "groups": [ { "title": "Properties", "children": [ 18752 ] } ] }, { "id": 18680, "name": "CreateTagRequest", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18681, "name": "tag", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The tag to be created." } ] }, "type": { "type": "reference", "target": 18670, "name": "Tag", "package": "@wix/tags_tags" } } ], "groups": [ { "title": "Properties", "children": [ 18681 ] } ] }, { "id": 18682, "name": "CreateTagResponse", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18683, "name": "tag", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The created tag." } ] }, "type": { "type": "reference", "target": 18670, "name": "Tag", "package": "@wix/tags_tags" } } ], "groups": [ { "title": "Properties", "children": [ 18683 ] } ] }, { "id": 18770, "name": "CreateTagResponseNonNullableFields", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18771, "name": "tag", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 18768, "name": "TagNonNullableFields", "package": "@wix/tags_tags" } } ], "groups": [ { "title": "Properties", "children": [ 18771 ] } ] }, { "id": 18761, "name": "DeleteTagForAccountRequest", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18762, "name": "tagId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "ID of the tag to delete." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 18762 ] } ] }, { "id": 18763, "name": "DeleteTagForAccountResponse", "variant": "declaration", "kind": 256, "flags": {} }, { "id": 18692, "name": "DeleteTagRequest", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18693, "name": "tagId", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "ID of the tag to delete." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 18693 ] } ] }, { "id": 18694, "name": "DeleteTagResponse", "variant": "declaration", "kind": 256, "flags": {} }, { "id": 18699, "name": "DomainEvent", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@oneof", "content": [] } ] }, "children": [ { "id": 18704, "name": "_id", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Unique event ID.\nAllows clients to ignore duplicate webhooks." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 18703, "name": "actionEvent", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 18725, "name": "ActionEvent", "package": "@wix/tags_tags" }, "overwrites": { "type": "reference", "target": 18716, "name": "DomainEventBodyOneOf.actionEvent" } }, { "id": 18700, "name": "createdEvent", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 18717, "name": "EntityCreatedEvent", "package": "@wix/tags_tags" }, "overwrites": { "type": "reference", "target": 18713, "name": "DomainEventBodyOneOf.createdEvent" } }, { "id": 18702, "name": "deletedEvent", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 18723, "name": "EntityDeletedEvent", "package": "@wix/tags_tags" }, "overwrites": { "type": "reference", "target": 18715, "name": "DomainEventBodyOneOf.deletedEvent" } }, { "id": 18711, "name": "entityEventSequence", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 18705, "name": "entityFqdn", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 18707, "name": "entityId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "ID of the entity associated with the event." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 18708, "name": "eventTime", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z" } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Date" }, "name": "Date", "package": "typescript" } ] } }, { "id": 18710, "name": "originatedFrom", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "If present, indicates the action that triggered the event." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 18706, "name": "slug", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 18709, "name": "triggeredByAnonymizeRequest", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR)." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "boolean" } ] } }, { "id": 18701, "name": "updatedEvent", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 18721, "name": "EntityUpdatedEvent", "package": "@wix/tags_tags" }, "overwrites": { "type": "reference", "target": 18714, "name": "DomainEventBodyOneOf.updatedEvent" } } ], "groups": [ { "title": "Properties", "children": [ 18704, 18703, 18700, 18702, 18711, 18705, 18707, 18708, 18710, 18706, 18709, 18701 ] } ], "extendedTypes": [ { "type": "reference", "target": 18712, "name": "DomainEventBodyOneOf", "package": "@wix/tags_tags" } ] }, { "id": 18712, "name": "DomainEventBodyOneOf", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@oneof", "content": [] } ] }, "children": [ { "id": 18716, "name": "actionEvent", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 18725, "name": "ActionEvent", "package": "@wix/tags_tags" } }, { "id": 18713, "name": "createdEvent", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 18717, "name": "EntityCreatedEvent", "package": "@wix/tags_tags" } }, { "id": 18715, "name": "deletedEvent", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 18723, "name": "EntityDeletedEvent", "package": "@wix/tags_tags" } }, { "id": 18714, "name": "updatedEvent", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 18721, "name": "EntityUpdatedEvent", "package": "@wix/tags_tags" } } ], "groups": [ { "title": "Properties", "children": [ 18716, 18713, 18715, 18714 ] } ], "extendedBy": [ { "type": "reference", "target": 18699, "name": "DomainEvent" } ] }, { "id": 18717, "name": "EntityCreatedEvent", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18718, "name": "entity", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 18718 ] } ] }, { "id": 18723, "name": "EntityDeletedEvent", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18724, "name": "deletedEntity", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Entity that was deleted" } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Properties", "children": [ 18724 ] } ] }, { "id": 18721, "name": "EntityUpdatedEvent", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18722, "name": "currentEntity", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 18722 ] } ] }, { "id": 18782, "name": "EventMetadata", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18783, "name": "_id", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Unique event ID.\nAllows clients to ignore duplicate webhooks." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 18790, "name": "entityEventSequence", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 18784, "name": "entityFqdn", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 18786, "name": "entityId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "ID of the entity associated with the event." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 18787, "name": "eventTime", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z" } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Date" }, "name": "Date", "package": "typescript" } ] } }, { "id": 18792, "name": "eventType", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Event type." } ] }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": 18780, "name": "BaseEventMetadata.eventType" } }, { "id": 18793, "name": "identity", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The identification type and identity data." } ] }, "type": { "type": "reference", "target": 18732, "name": "IdentificationData", "package": "@wix/tags_tags" }, "inheritedFrom": { "type": "reference", "target": 18781, "name": "BaseEventMetadata.identity" } }, { "id": 18791, "name": "instanceId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "App instance ID." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] }, "inheritedFrom": { "type": "reference", "target": 18779, "name": "BaseEventMetadata.instanceId" } }, { "id": 18789, "name": "originatedFrom", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "If present, indicates the action that triggered the event." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 18785, "name": "slug", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 18788, "name": "triggeredByAnonymizeRequest", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR)." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "boolean" } ] } } ], "groups": [ { "title": "Properties", "children": [ 18783, 18790, 18784, 18786, 18787, 18792, 18793, 18791, 18789, 18785, 18788 ] } ], "extendedTypes": [ { "type": "reference", "target": 18778, "name": "BaseEventMetadata", "package": "@wix/tags_tags" } ] }, { "id": 18753, "name": "GetTagForAccountRequest", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18754, "name": "tagId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The ID of the tag to retrieve." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 18754 ] } ] }, { "id": 18755, "name": "GetTagForAccountResponse", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18756, "name": "tag", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The requested tag." } ] }, "type": { "type": "reference", "target": 18670, "name": "Tag", "package": "@wix/tags_tags" } } ], "groups": [ { "title": "Properties", "children": [ 18756 ] } ] }, { "id": 18684, "name": "GetTagRequest", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18685, "name": "tagId", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The ID of the tag to retrieve." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 18685 ] } ] }, { "id": 18686, "name": "GetTagResponse", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18687, "name": "tag", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The requested tag." } ] }, "type": { "type": "reference", "target": 18670, "name": "Tag", "package": "@wix/tags_tags" } } ], "groups": [ { "title": "Properties", "children": [ 18687 ] } ] }, { "id": 18772, "name": "GetTagResponseNonNullableFields", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18773, "name": "tag", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 18768, "name": "TagNonNullableFields", "package": "@wix/tags_tags" } } ], "groups": [ { "title": "Properties", "children": [ 18773 ] } ] }, { "id": 18732, "name": "IdentificationData", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@oneof", "content": [] } ] }, "children": [ { "id": 18733, "name": "anonymousVisitorId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "ID of a site visitor that has not logged in to the site." } ] }, "type": { "type": "intrinsic", "name": "string" }, "overwrites": { "type": "reference", "target": 18739, "name": "IdentificationDataIdOneOf.anonymousVisitorId" } }, { "id": 18736, "name": "appId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "ID of an app." } ] }, "type": { "type": "intrinsic", "name": "string" }, "overwrites": { "type": "reference", "target": 18742, "name": "IdentificationDataIdOneOf.appId" } }, { "id": 18737, "name": "identityType", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "type": { "type": "reference", "target": 18743, "name": "WebhookIdentityType", "package": "@wix/tags_tags" } }, { "id": 18734, "name": "memberId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "ID of a site visitor that has logged in to the site." } ] }, "type": { "type": "intrinsic", "name": "string" }, "overwrites": { "type": "reference", "target": 18740, "name": "IdentificationDataIdOneOf.memberId" } }, { "id": 18735, "name": "wixUserId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "ID of a Wix user (site owner, contributor, etc.)." } ] }, "type": { "type": "intrinsic", "name": "string" }, "overwrites": { "type": "reference", "target": 18741, "name": "IdentificationDataIdOneOf.wixUserId" } } ], "groups": [ { "title": "Properties", "children": [ 18733, 18736, 18737, 18734, 18735 ] } ], "extendedTypes": [ { "type": "reference", "target": 18738, "name": "IdentificationDataIdOneOf", "package": "@wix/tags_tags" } ] }, { "id": 18738, "name": "IdentificationDataIdOneOf", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@oneof", "content": [] } ] }, "children": [ { "id": 18739, "name": "anonymousVisitorId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "ID of a site visitor that has not logged in to the site." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 18742, "name": "appId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "ID of an app." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 18740, "name": "memberId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "ID of a site visitor that has logged in to the site." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 18741, "name": "wixUserId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "ID of a Wix user (site owner, contributor, etc.)." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 18739, 18742, 18740, 18741 ] } ], "extendedBy": [ { "type": "reference", "target": 18732, "name": "IdentificationData" } ] }, { "id": 18764, "name": "ListTagsForAccountRequest", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18765, "name": "fqdn", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The Fully Qualified Domain Name (FQDN) to which the tags are associated. Currently supports only eCommerce Orders: " }, { "kind": "code", "text": "`wix.ecom.v1.order`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 18765 ] } ] }, { "id": 18766, "name": "ListTagsForAccountResponse", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18767, "name": "tags", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "A list of tags." } ] }, "type": { "type": "array", "elementType": { "type": "reference", "target": 18670, "name": "Tag", "package": "@wix/tags_tags" } } } ], "groups": [ { "title": "Properties", "children": [ 18767 ] } ] }, { "id": 18695, "name": "ListTagsRequest", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18696, "name": "fqdn", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The Fully Qualified Domain Name (FQDN) to which the tags are associated. Currently supports only eCommerce Orders: " }, { "kind": "code", "text": "`wix.ecom.v1.order`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 18696 ] } ] }, { "id": 18697, "name": "ListTagsResponse", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18698, "name": "tags", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "A list of tags." } ] }, "type": { "type": "array", "elementType": { "type": "reference", "target": 18670, "name": "Tag", "package": "@wix/tags_tags" } } } ], "groups": [ { "title": "Properties", "children": [ 18698 ] } ] }, { "id": 18776, "name": "ListTagsResponseNonNullableFields", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18777, "name": "tags", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "array", "elementType": { "type": "reference", "target": 18768, "name": "TagNonNullableFields", "package": "@wix/tags_tags" } } } ], "groups": [ { "title": "Properties", "children": [ 18777 ] } ] }, { "id": 18727, "name": "MessageEnvelope", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18731, "name": "data", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Stringify payload." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 18729, "name": "eventType", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Event type." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 18730, "name": "identity", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The identification type and identity data." } ] }, "type": { "type": "reference", "target": 18732, "name": "IdentificationData", "package": "@wix/tags_tags" } }, { "id": 18728, "name": "instanceId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "App instance ID." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Properties", "children": [ 18731, 18729, 18730, 18728 ] } ] }, { "id": 18719, "name": "RestoreInfo", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18720, "name": "deletedDate", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Date" }, "name": "Date", "package": "typescript" } ] } } ], "groups": [ { "title": "Properties", "children": [ 18720 ] } ] }, { "id": 18670, "name": "Tag", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18673, "name": "_createdDate", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Date and time the tag was created." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Date" }, "name": "Date", "package": "typescript" } ] } }, { "id": 18671, "name": "_id", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Tag ID." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 18674, "name": "_updatedDate", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Date and time the tag was last updated." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Date" }, "name": "Date", "package": "typescript" } ] } }, { "id": 18676, "name": "fqdn", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "FQDN of the entity that belongs to this tag." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 18675, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Tag name." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 18672, "name": "revision", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Revision number, which increments by 1 each time the tag is updated." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Properties", "children": [ 18673, 18671, 18674, 18676, 18675, 18672 ] } ] }, { "id": 18794, "name": "TagCreatedEnvelope", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18795, "name": "entity", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", "target": 18670, "name": "Tag", "package": "@wix/tags_tags" } }, { "id": 18796, "name": "metadata", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", "target": 18782, "name": "EventMetadata", "package": "@wix/tags_tags" } } ], "groups": [ { "title": "Properties", "children": [ 18795, 18796 ] } ] }, { "id": 18797, "name": "TagDeletedEnvelope", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18798, "name": "entity", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", "target": 18670, "name": "Tag", "package": "@wix/tags_tags" } }, { "id": 18799, "name": "metadata", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", "target": 18782, "name": "EventMetadata", "package": "@wix/tags_tags" } } ], "groups": [ { "title": "Properties", "children": [ 18798, 18799 ] } ] }, { "id": 18768, "name": "TagNonNullableFields", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18769, "name": "exposure", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", "target": 18677, "name": "TagExposure", "package": "@wix/tags_tags" } } ], "groups": [ { "title": "Properties", "children": [ 18769 ] } ] }, { "id": 18800, "name": "TagUpdatedEnvelope", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18801, "name": "entity", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", "target": 18670, "name": "Tag", "package": "@wix/tags_tags" } }, { "id": 18802, "name": "metadata", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", "target": 18782, "name": "EventMetadata", "package": "@wix/tags_tags" } } ], "groups": [ { "title": "Properties", "children": [ 18801, 18802 ] } ] }, { "id": 18803, "name": "UpdateTag", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18806, "name": "_createdDate", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Date and time the tag was created." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Date" }, "name": "Date", "package": "typescript" } ] } }, { "id": 18804, "name": "_id", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Tag ID." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 18807, "name": "_updatedDate", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Date and time the tag was last updated." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Date" }, "name": "Date", "package": "typescript" } ] } }, { "id": 18809, "name": "fqdn", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "FQDN of the entity that belongs to this tag." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 18808, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Tag name." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 18805, "name": "revision", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Revision number, which increments by 1 each time the tag is updated." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Properties", "children": [ 18806, 18804, 18807, 18809, 18808, 18805 ] } ] }, { "id": 18757, "name": "UpdateTagForAccountRequest", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18758, "name": "tag", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The tag to be updated, which may be partial." } ] }, "type": { "type": "reference", "target": 18670, "name": "Tag", "package": "@wix/tags_tags" } } ], "groups": [ { "title": "Properties", "children": [ 18758 ] } ] }, { "id": 18759, "name": "UpdateTagForAccountResponse", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18760, "name": "tag", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The updated tag." } ] }, "type": { "type": "reference", "target": 18670, "name": "Tag", "package": "@wix/tags_tags" } } ], "groups": [ { "title": "Properties", "children": [ 18760 ] } ] }, { "id": 18688, "name": "UpdateTagRequest", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18689, "name": "tag", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The tag to be updated, which may be partial." } ] }, "type": { "type": "reference", "target": 18670, "name": "Tag", "package": "@wix/tags_tags" } } ], "groups": [ { "title": "Properties", "children": [ 18689 ] } ] }, { "id": 18690, "name": "UpdateTagResponse", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18691, "name": "tag", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The updated tag." } ] }, "type": { "type": "reference", "target": 18670, "name": "Tag", "package": "@wix/tags_tags" } } ], "groups": [ { "title": "Properties", "children": [ 18691 ] } ] }, { "id": 18774, "name": "UpdateTagResponseNonNullableFields", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 18775, "name": "tag", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 18768, "name": "TagNonNullableFields", "package": "@wix/tags_tags" } } ], "groups": [ { "title": "Properties", "children": [ 18775 ] } ] }, { "id": 18654, "name": "createTag", "variant": "declaration", "kind": 64, "flags": { "isPublic": true }, "signatures": [ { "id": 18655, "name": "createTag", "variant": "signature", "kind": 4096, "flags": { "isPublic": true }, "comment": { "summary": [ { "kind": "text", "text": "Creates a tag." } ], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "tag" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "tag.fqdn" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "tag.name" } ] }, { "tag": "@permissionId", "content": [ { "kind": "text", "text": "TAGS.TAG_CREATE" } ] }, { "tag": "@permissionScope", "content": [ { "kind": "text", "text": "Manage Tags" } ] }, { "tag": "@permissionScopeId", "content": [ { "kind": "text", "text": "SCOPE.DC-OS.MANAGE-TAGS" } ] }, { "tag": "@applicableIdentity", "content": [ { "kind": "text", "text": "APP" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "The created tag." } ] } ] }, "parameters": [ { "id": 18656, "name": "tag", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The tag to be created." } ] }, "type": { "type": "reference", "target": 18670, "name": "Tag", "package": "@wix/tags_tags" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": 18670, "name": "Tag", "package": "@wix/tags_tags" }, { "type": "reference", "target": 18768, "name": "TagNonNullableFields", "package": "@wix/tags_tags" } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 18664, "name": "deleteTag", "variant": "declaration", "kind": 64, "flags": { "isPublic": true }, "signatures": [ { "id": 18665, "name": "deleteTag", "variant": "signature", "kind": 4096, "flags": { "isPublic": true }, "comment": { "summary": [ { "kind": "text", "text": "Deletes a tag." } ], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "tagId" } ] }, { "tag": "@permissionId", "content": [ { "kind": "text", "text": "TAGS.TAG_DELETE" } ] }, { "tag": "@permissionScope", "content": [ { "kind": "text", "text": "Manage Tags" } ] }, { "tag": "@permissionScopeId", "content": [ { "kind": "text", "text": "SCOPE.DC-OS.MANAGE-TAGS" } ] }, { "tag": "@applicableIdentity", "content": [ { "kind": "text", "text": "APP" } ] } ] }, "parameters": [ { "id": 18666, "name": "tagId", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "ID of the tag to delete." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 18657, "name": "getTag", "variant": "declaration", "kind": 64, "flags": { "isPublic": true }, "signatures": [ { "id": 18658, "name": "getTag", "variant": "signature", "kind": 4096, "flags": { "isPublic": true }, "comment": { "summary": [ { "kind": "text", "text": "Retrieves a tag." } ], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "tagId" } ] }, { "tag": "@permissionId", "content": [ { "kind": "text", "text": "TAGS.TAG_READ" } ] }, { "tag": "@permissionScope", "content": [ { "kind": "text", "text": "Manage Bookings Services and Settings" } ] }, { "tag": "@permissionScopeId", "content": [ { "kind": "text", "text": "SCOPE.BOOKINGS.CONFIGURATION" } ] }, { "tag": "@permissionScope", "content": [ { "kind": "text", "text": "Manage Portfolio" } ] }, { "tag": "@permissionScopeId", "content": [ { "kind": "text", "text": "SCOPE.PORTFOLIO.MANAGE-PORTFOLIO" } ] }, { "tag": "@permissionScope", "content": [ { "kind": "text", "text": "Manage Restaurants - all permissions" } ] }, { "tag": "@permissionScopeId", "content": [ { "kind": "text", "text": "SCOPE.RESTAURANTS.MEGA-SCOPES" } ] }, { "tag": "@permissionScope", "content": [ { "kind": "text", "text": "Manage Tags" } ] }, { "tag": "@permissionScopeId", "content": [ { "kind": "text", "text": "SCOPE.DC-OS.MANAGE-TAGS" } ] }, { "tag": "@permissionScope", "content": [ { "kind": "text", "text": "Read Tags" } ] }, { "tag": "@permissionScopeId", "content": [ { "kind": "text", "text": "SCOPE.DC-OS.READ-TAGS" } ] }, { "tag": "@applicableIdentity", "content": [ { "kind": "text", "text": "APP" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "The requested tag." } ] } ] }, "parameters": [ { "id": 18659, "name": "tagId", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The ID of the tag to retrieve." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": 18670, "name": "Tag", "package": "@wix/tags_tags" }, { "type": "reference", "target": 18768, "name": "TagNonNullableFields", "package": "@wix/tags_tags" } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 18667, "name": "listTags", "variant": "declaration", "kind": 64, "flags": { "isPublic": true }, "signatures": [ { "id": 18668, "name": "listTags", "variant": "signature", "kind": 4096, "flags": { "isPublic": true }, "comment": { "summary": [ { "kind": "text", "text": "Retrieves a list of tags." } ], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "fqdn" } ] }, { "tag": "@permissionId", "content": [ { "kind": "text", "text": "TAGS.TAG_READ" } ] }, { "tag": "@permissionScope", "content": [ { "kind": "text", "text": "Manage Bookings Services and Settings" } ] }, { "tag": "@permissionScopeId", "content": [ { "kind": "text", "text": "SCOPE.BOOKINGS.CONFIGURATION" } ] }, { "tag": "@permissionScope", "content": [ { "kind": "text", "text": "Manage Portfolio" } ] }, { "tag": "@permissionScopeId", "content": [ { "kind": "text", "text": "SCOPE.PORTFOLIO.MANAGE-PORTFOLIO" } ] }, { "tag": "@permissionScope", "content": [ { "kind": "text", "text": "Manage Restaurants - all permissions" } ] }, { "tag": "@permissionScopeId", "content": [ { "kind": "text", "text": "SCOPE.RESTAURANTS.MEGA-SCOPES" } ] }, { "tag": "@permissionScope", "content": [ { "kind": "text", "text": "Manage Tags" } ] }, { "tag": "@permissionScopeId", "content": [ { "kind": "text", "text": "SCOPE.DC-OS.MANAGE-TAGS" } ] }, { "tag": "@permissionScope", "content": [ { "kind": "text", "text": "Read Tags" } ] }, { "tag": "@permissionScopeId", "content": [ { "kind": "text", "text": "SCOPE.DC-OS.READ-TAGS" } ] }, { "tag": "@applicableIdentity", "content": [ { "kind": "text", "text": "APP" } ] } ] }, "parameters": [ { "id": 18669, "name": "fqdn", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The Fully Qualified Domain Name (FQDN) to which the tags are associated. Currently supports only eCommerce Orders: " }, { "kind": "code", "text": "`wix.ecom.v1.order`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": 18697, "name": "ListTagsResponse", "package": "@wix/tags_tags" }, { "type": "reference", "target": 18776, "name": "ListTagsResponseNonNullableFields", "package": "@wix/tags_tags" } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 18636, "name": "onTagCreated", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 18637, "name": "onTagCreated", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@webhook", "content": [] }, { "tag": "@eventType", "content": [ { "kind": "text", "text": "wix.os.tags.v1.tag_created" } ] }, { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] } ] }, "parameters": [ { "id": 18638, "name": "handler", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 18639, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 18640, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 18641, "name": "event", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 18794, "name": "TagCreatedEnvelope", "package": "@wix/tags_tags" } } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "void" }, { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } ] } } ] } } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 18642, "name": "onTagDeleted", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 18643, "name": "onTagDeleted", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@webhook", "content": [] }, { "tag": "@eventType", "content": [ { "kind": "text", "text": "wix.os.tags.v1.tag_deleted" } ] }, { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] } ] }, "parameters": [ { "id": 18644, "name": "handler", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 18645, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 18646, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 18647, "name": "event", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 18797, "name": "TagDeletedEnvelope", "package": "@wix/tags_tags" } } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "void" }, { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } ] } } ] } } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 18648, "name": "onTagUpdated", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 18649, "name": "onTagUpdated", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@webhook", "content": [] }, { "tag": "@eventType", "content": [ { "kind": "text", "text": "wix.os.tags.v1.tag_updated" } ] }, { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] } ] }, "parameters": [ { "id": 18650, "name": "handler", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 18651, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 18652, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 18653, "name": "event", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 18800, "name": "TagUpdatedEnvelope", "package": "@wix/tags_tags" } } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "void" }, { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } ] } } ] } } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 18660, "name": "updateTag", "variant": "declaration", "kind": 64, "flags": { "isPublic": true }, "signatures": [ { "id": 18661, "name": "updateTag", "variant": "signature", "kind": 4096, "flags": { "isPublic": true }, "comment": { "summary": [ { "kind": "text", "text": "Updates a tag." } ], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "_id" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "tag" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "tag.name" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "tag.revision" } ] }, { "tag": "@permissionId", "content": [ { "kind": "text", "text": "TAGS.TAG_UPDATE" } ] }, { "tag": "@permissionScope", "content": [ { "kind": "text", "text": "Manage Tags" } ] }, { "tag": "@permissionScopeId", "content": [ { "kind": "text", "text": "SCOPE.DC-OS.MANAGE-TAGS" } ] }, { "tag": "@applicableIdentity", "content": [ { "kind": "text", "text": "APP" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "The updated tag." } ] } ] }, "parameters": [ { "id": 18662, "name": "_id", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Tag ID." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 18663, "name": "tag", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 18803, "name": "UpdateTag", "package": "@wix/tags_tags" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": 18670, "name": "Tag", "package": "@wix/tags_tags" }, { "type": "reference", "target": 18768, "name": "TagNonNullableFields", "package": "@wix/tags_tags" } ] } ], "name": "Promise", "package": "typescript" } } ] } ], "groups": [ { "title": "Enumerations", "children": [ 18677, 18743 ] }, { "title": "Interfaces", "children": [ 18725, 18778, 18749, 18751, 18680, 18682, 18770, 18761, 18763, 18692, 18694, 18699, 18712, 18717, 18723, 18721, 18782, 18753, 18755, 18684, 18686, 18772, 18732, 18738, 18764, 18766, 18695, 18697, 18776, 18727, 18719, 18670, 18794, 18797, 18768, 18800, 18803, 18757, 18759, 18688, 18690, 18774 ] }, { "title": "Functions", "children": [ 18654, 18664, 18657, 18667, 18636, 18642, 18648, 18660 ] } ], "packageName": "@wix/tags_tags", "symbolIdMap": {} }, "appendices": { "/": [ { "type": "GUIDE", "title": "Introduction", "src": "# About the Tags API\n\nTags are labels attached to entities, allowing for flexible categorization and data management. For example, you can use tags to filter entities in a table view.\n\nWith the Tags API, you can:\n\n* Retrieve detailed information about a specific tag.\n* List all tags associated with a specific Fully Qualified Domain Name (FQDN).\n\nA FQDN serves as an identifier for the primary entity of an API, such as [Orders](https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/setup). For instance, an eCommerce order can have associated tags. When retrieving information about an order, such as through [Get Order](https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/get-order), the response includes any related tags. To retrieve all tags for all orders, call [List Tags](https://dev.wix.com/docs/sdk/backend-modules/tags/tags/list-tags) with the Orders FQDN.\n\n## Before you begin\n\nIt's important to note that:\n\n* The Tags API currently supports only the eCommerce Orders FQDN: `wix.ecom.v1.order`.\n* Each FQDN can have a maximum of 100 tags.\n\n## Terminology\n\n* **FQDN (Fully Qualified Domain Name):** The unique identifier for the primary entity of an API, such as [Orders](https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/setup)." }, { "type": "GUIDE", "title": "Setup", "src": "To use the Tags API, install the `@wix/tags` package using npm or Yarn:\n ```console\nnpm install @wix/tags\n```\n\nor\n\n```console\nyarn add @wix/tags\n```\n\nThen import `{ tags }` from `@wix/tags`:\n\n```js\nimport { tags } from '@wix/tags'\n```\n " } ], "/createTag": [ { "type": "EXAMPLE", "title": "createTag: Wix-hosted", "src": "import { tags } from '@wix/tags';\n\nasync function createTag(tag) {\n const response = await tags.createTag(tag);\n};" }, { "type": "EXAMPLE", "title": "createTag: Self-hosted", "src": "import { createClient } from '@wix/sdk';\nimport { tags } from '@wix/tags';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { tags },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function createTag(tag) {\n const response = await myWixClient.tags.createTag(tag);\n};", "description": "Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client)." }, { "type": "ERROR", "title": "/createTag Errors", "src": "", "errors": [ { "httpCode": 404, "statusCode": "NOT_FOUND", "applicationCode": "FQDN_NOT_FOUND", "errorType": "APPLICATION", "applicationCodeData": { "applicationCode": "FQDN_NOT_FOUND" } }, { "httpCode": 409, "statusCode": "ALREADY_EXISTS", "applicationCode": "TAG_NAME_ALREADY_EXISTS", "errorType": "APPLICATION", "applicationCodeData": { "applicationCode": "TAG_NAME_ALREADY_EXISTS" } }, { "httpCode": 429, "statusCode": "RESOURCE_EXHAUSTED", "applicationCode": "TAGS_REACHED_LIMIT", "errorType": "APPLICATION", "applicationCodeData": { "applicationCode": "TAGS_REACHED_LIMIT" } }, { "httpCode": 500, "statusCode": "INTERNAL", "applicationCode": "CREATE_ID_EXHAUSTED_RETRY_ATTEMPTS", "errorType": "APPLICATION", "applicationCodeData": { "applicationCode": "CREATE_ID_EXHAUSTED_RETRY_ATTEMPTS" } }, { "httpCode": 400, "statusCode": "INVALID_ARGUMENT", "applicationCode": "EXPOSURE_NOT_SUPPORTED", "errorType": "APPLICATION", "applicationCodeData": { "applicationCode": "EXPOSURE_NOT_SUPPORTED" } } ] } ], "/createTagForAccount": [ { "type": "EXAMPLE", "title": "createTagForAccount: Wix-hosted", "src": "import { tags } from '@wix/tags';\n\nasync function createTagForAccount(tag) {\n const response = await tags.createTagForAccount(tag);\n};" }, { "type": "EXAMPLE", "title": "createTagForAccount: Self-hosted", "src": "import { createClient } from '@wix/sdk';\nimport { tags } from '@wix/tags';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { tags },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function createTagForAccount(tag) {\n const response = await myWixClient.tags.createTagForAccount(tag);\n};", "description": "Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client)." }, { "type": "ERROR", "title": "/createTagForAccount Errors", "src": "", "errors": [ { "httpCode": 404, "statusCode": "NOT_FOUND", "applicationCode": "FQDN_NOT_FOUND", "errorType": "APPLICATION", "applicationCodeData": { "applicationCode": "FQDN_NOT_FOUND" } }, { "httpCode": 409, "statusCode": "ALREADY_EXISTS", "applicationCode": "TAG_NAME_ALREADY_EXISTS", "errorType": "APPLICATION", "applicationCodeData": { "applicationCode": "TAG_NAME_ALREADY_EXISTS" } }, { "httpCode": 429, "statusCode": "RESOURCE_EXHAUSTED", "applicationCode": "TAGS_REACHED_LIMIT", "errorType": "APPLICATION", "applicationCodeData": { "applicationCode": "TAGS_REACHED_LIMIT" } }, { "httpCode": 500, "statusCode": "INTERNAL", "applicationCode": "CREATE_ID_EXHAUSTED_RETRY_ATTEMPTS", "errorType": "APPLICATION", "applicationCodeData": { "applicationCode": "CREATE_ID_EXHAUSTED_RETRY_ATTEMPTS" } } ] } ], "/deleteTag": [ { "type": "EXAMPLE", "title": "deleteTag: Wix-hosted", "src": "import { tags } from '@wix/tags';\n\nasync function deleteTag(tagId) {\n const response = await tags.deleteTag(tagId);\n};" }, { "type": "EXAMPLE", "title": "deleteTag: Self-hosted", "src": "import { createClient } from '@wix/sdk';\nimport { tags } from '@wix/tags';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { tags },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function deleteTag(tagId) {\n const response = await myWixClient.tags.deleteTag(tagId);\n};", "description": "Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client)." } ], "/deleteTagForAccount": [ { "type": "EXAMPLE", "title": "deleteTagForAccount: Wix-hosted", "src": "import { tags } from '@wix/tags';\n\nasync function deleteTagForAccount(tagId) {\n const response = await tags.deleteTagForAccount(tagId);\n};" }, { "type": "EXAMPLE", "title": "deleteTagForAccount: Self-hosted", "src": "import { createClient } from '@wix/sdk';\nimport { tags } from '@wix/tags';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { tags },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function deleteTagForAccount(tagId) {\n const response = await myWixClient.tags.deleteTagForAccount(tagId);\n};", "description": "Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client)." } ], "/getTag": [ { "type": "EXAMPLE", "title": "getTag: Wix-hosted", "src": "import { tags } from '@wix/tags';\n\nasync function getTag(tagId) {\n const response = await tags.getTag(tagId);\n};" }, { "type": "EXAMPLE", "title": "getTag: Self-hosted", "src": "import { createClient } from '@wix/sdk';\nimport { tags } from '@wix/tags';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { tags },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function getTag(tagId) {\n const response = await myWixClient.tags.getTag(tagId);\n};", "description": "Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client)." } ], "/getTagForAccount": [ { "type": "EXAMPLE", "title": "getTagForAccount: Wix-hosted", "src": "import { tags } from '@wix/tags';\n\nasync function getTagForAccount(tagId) {\n const response = await tags.getTagForAccount(tagId);\n};" }, { "type": "EXAMPLE", "title": "getTagForAccount: Self-hosted", "src": "import { createClient } from '@wix/sdk';\nimport { tags } from '@wix/tags';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { tags },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function getTagForAccount(tagId) {\n const response = await myWixClient.tags.getTagForAccount(tagId);\n};", "description": "Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client)." } ], "/listTags": [ { "type": "EXAMPLE", "title": "listTags: Wix-hosted", "src": "import { tags } from '@wix/tags';\n\nasync function listTags(fqdn) {\n const response = await tags.listTags(fqdn);\n};" }, { "type": "EXAMPLE", "title": "listTags: Self-hosted", "src": "import { createClient } from '@wix/sdk';\nimport { tags } from '@wix/tags';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { tags },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function listTags(fqdn) {\n const response = await myWixClient.tags.listTags(fqdn);\n};", "description": "Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client)." } ], "/listTagsForAccount": [ { "type": "EXAMPLE", "title": "listTagsForAccount: Wix-hosted", "src": "import { tags } from '@wix/tags';\n\nasync function listTagsForAccount(fqdn) {\n const response = await tags.listTagsForAccount(fqdn);\n};" }, { "type": "EXAMPLE", "title": "listTagsForAccount: Self-hosted", "src": "import { createClient } from '@wix/sdk';\nimport { tags } from '@wix/tags';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { tags },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function listTagsForAccount(fqdn) {\n const response = await myWixClient.tags.listTagsForAccount(fqdn);\n};", "description": "Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client)." } ], "/onTagCreated": [ { "type": "EXAMPLE", "title": "onTagCreated: Wix-hosted", "src": "import { tags } from '@wix/tags';\n\ntags.onTagCreated((event) => {\n // handle your event here\n});" }, { "type": "EXAMPLE", "title": "onTagCreated: Self-hosted", "src": "import { createClient, AppStrategy } from '@wix/sdk';\nimport { tags } from '@wix/tags';\n\nconst wixClient = createClient({\n auth: AppStrategy({\n appId: 'MY-APP-ID',\n publicKey: 'YOUR_APP_PUBLIC_KEY',\n }),\n modules: {\n tags,\n },\n});\n\nwixClient.tags.onTagCreated((event) => {\n // handle your event here\n});" } ], "/onTagDeleted": [ { "type": "EXAMPLE", "title": "onTagDeleted: Wix-hosted", "src": "import { tags } from '@wix/tags';\n\ntags.onTagDeleted((event) => {\n // handle your event here\n});" }, { "type": "EXAMPLE", "title": "onTagDeleted: Self-hosted", "src": "import { createClient, AppStrategy } from '@wix/sdk';\nimport { tags } from '@wix/tags';\n\nconst wixClient = createClient({\n auth: AppStrategy({\n appId: 'MY-APP-ID',\n publicKey: 'YOUR_APP_PUBLIC_KEY',\n }),\n modules: {\n tags,\n },\n});\n\nwixClient.tags.onTagDeleted((event) => {\n // handle your event here\n});" } ], "/onTagUpdated": [ { "type": "EXAMPLE", "title": "onTagUpdated: Wix-hosted", "src": "import { tags } from '@wix/tags';\n\ntags.onTagUpdated((event) => {\n // handle your event here\n});" }, { "type": "EXAMPLE", "title": "onTagUpdated: Self-hosted", "src": "import { createClient, AppStrategy } from '@wix/sdk';\nimport { tags } from '@wix/tags';\n\nconst wixClient = createClient({\n auth: AppStrategy({\n appId: 'MY-APP-ID',\n publicKey: 'YOUR_APP_PUBLIC_KEY',\n }),\n modules: {\n tags,\n },\n});\n\nwixClient.tags.onTagUpdated((event) => {\n // handle your event here\n});" } ], "/updateTag": [ { "type": "EXAMPLE", "title": "updateTag: Wix-hosted", "src": "import { tags } from '@wix/tags';\n\nasync function updateTag(id, tag) {\n const response = await tags.updateTag(id, tag);\n};" }, { "type": "EXAMPLE", "title": "updateTag: Self-hosted", "src": "import { createClient } from '@wix/sdk';\nimport { tags } from '@wix/tags';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { tags },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function updateTag(id, tag) {\n const response = await myWixClient.tags.updateTag(id, tag);\n};", "description": "Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client)." } ], "/updateTagForAccount": [ { "type": "EXAMPLE", "title": "updateTagForAccount: Wix-hosted", "src": "import { tags } from '@wix/tags';\n\nasync function updateTagForAccount(id, tag) {\n const response = await tags.updateTagForAccount(id, tag);\n};" }, { "type": "EXAMPLE", "title": "updateTagForAccount: Self-hosted", "src": "import { createClient } from '@wix/sdk';\nimport { tags } from '@wix/tags';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { tags },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function updateTagForAccount(id, tag) {\n const response = await myWixClient.tags.updateTagForAccount(id, tag);\n};", "description": "Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client)." } ] }, "standaloneTypes": {}, "metadata": { "fqdn": "wix.os.tags.v1.tag" } }