{ "openapi": "3.0.0", "info": { "title": "Inside Labs API", "description": "\nThe **Inside Labs API** powers personalised, event-driven experiences for\ntourism destinations — aggregating activities, memberships, bookings and\nengagement campaigns behind a single, consistent REST surface.\n\n## Base URL\n\nAll domains are reachable through a single base URL. The first path segment\nselects the domain.\n\n```\nhttps://api.insidelabs.io/{domain}/{path}\n```\n\n## Required headers\n\nEvery request must include:\n\n| Header | Purpose |\n| --------------- | ------------------------------------------------------------- |\n| `Authorization` | `Bearer ` from the OAuth client credentials flow |\n| `x-omni-tenant` | Identifies which tenant (destination) you are operating against |\n\n## Environments\n\n| Environment | Base URL |\n| ----------- | --------------------------------- |\n| Production | `https://api.insidelabs.io` |\n| Development | `https://api.dev.insidelabs.io` |\n\n## Authentication\n\nAuthentication uses **OAuth 2.0 Client Credentials**. Exchange your\n`client_id` and `client_secret` for a short-lived bearer token and reuse it\nacross requests until it expires. Credentials are issued per tenant and per\nenvironment by the Inside Labs team.\n\n## Events & subscriptions\n\nThe platform is event-driven. Each domain publishes events to a central bus\nowned by the **Event** domain. To react to platform changes in real time,\nregister a subscription via the Event domain's API.\n\n## Full developer guide\n\nFor onboarding, walkthroughs and conceptual documentation see the\n[Inside Labs Developer Portal](https://inside-labs.github.io/omni-domain-docs/).\n", "version": "1.0.0" }, "servers": [ { "url": "https://api.dev.insidelabs.io" } ], "paths": { "/auth/token": { "post": { "operationId": "Get Token", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetTokenRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetTokenResponse" } } } } }, "parameters": [] } }, "/auth/health": { "get": { "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sharedsharek7dskBQQVdPF" } } } } }, "parameters": [] } }, "/auth/": {}, "/memberships/settings": { "get": { "operationId": "Get Membership Settings", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniEmptyRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetMembershipSettingsResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] }, "put": { "operationId": "Update Membership Settings", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniUpdateMembershipSettingsRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniUpdateMembershipSettingsResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] } }, "/memberships/programs/{program}": { "get": { "operationId": "Get Membership Program", "parameters": [ { "name": "program", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniEmptyRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetMembershipProgramResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ] }, "put": { "operationId": "Update Membership Program", "parameters": [ { "name": "program", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniUpdateMembershipProgramRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniUpdateMembershipProgramResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ] }, "delete": { "operationId": "Delete Membership Program", "parameters": [ { "name": "program", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniEmptyRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniDeleteMembershipProgramResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ] } }, "/memberships/users": {}, "/memberships/tenants/{tenant}": { "get": { "operationId": "Get Tenant User Memberships", "parameters": [ { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniEmptyRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetTenantUserMembershipsResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ] } }, "/memberships/tenants": {}, "/memberships/users/{user}/memberships/activate": { "post": { "operationId": "Activate User Membership", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniActivateUserMembershipRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniActivateUserMembershipResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ] } }, "/memberships/users/{user}": {}, "/memberships/definitions": { "get": { "operationId": "List Membership Definitions", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniEmptyRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetMembershipDefinitionsResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] }, "post": { "operationId": "Create Membership Definition", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniCreateMembershipDefinitionRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniCreateMembershipDefinitionResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] } }, "/memberships/providers": { "get": { "operationId": "List Membership Providers", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniEmptyRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetMembershipProvidersResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] }, "post": { "operationId": "Create Membership Provider", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniCreateMembershipProviderRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniCreateMembershipProviderResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] } }, "/memberships/users/{user}/memberships": { "get": { "operationId": "Get User Memberships", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniEmptyRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetUserMembershipsResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ] }, "post": { "operationId": "Grant User Membership", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGrantUserMembershipRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGrantUserMembershipResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ] } }, "/memberships/providers/{provider}": { "get": { "operationId": "Get Membership Provider", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniEmptyRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetMembershipProviderResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ] }, "put": { "operationId": "Update Membership Provider", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniUpdateMembershipProviderRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniUpdateMembershipProviderResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ] }, "delete": { "operationId": "Delete Membership Provider", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniEmptyRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniDeleteMembershipProviderResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ] } }, "/memberships/": {}, "/memberships/categories": { "get": { "operationId": "List Membership Categories", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniEmptyRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetMembershipCategoriesResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] }, "post": { "operationId": "Create Membership Category", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniCreateMembershipCategoryRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniCreateMembershipCategoryResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] } }, "/memberships/categories/{category}": { "get": { "operationId": "Get Membership Category", "parameters": [ { "name": "category", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniEmptyRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetMembershipCategoryResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ] }, "put": { "operationId": "Update Membership Category", "parameters": [ { "name": "category", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniUpdateMembershipCategoryRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniUpdateMembershipCategoryResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ] }, "delete": { "operationId": "Delete Membership Category", "parameters": [ { "name": "category", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniEmptyRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniDeleteMembershipCategoryResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ] } }, "/memberships/health": { "get": { "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/davosdavosJZMkVNodXyHQ" } } } } }, "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] } }, "/memberships/users/{user}/memberships/{membership}": { "delete": { "operationId": "Revoke User Membership", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "membership", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniRevokeUserMembershipRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniRevokeUserMembershipResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ] } }, "/memberships/offers": { "get": { "operationId": "List Membership Offers", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniEmptyRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetMembershipOffersResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] }, "post": { "operationId": "Create Membership Offer", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniCreateMembershipOfferRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniCreateMembershipOfferResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] } }, "/memberships/offers/{offer}": { "get": { "operationId": "Get Membership Offer", "parameters": [ { "name": "offer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniEmptyRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetMembershipOfferResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ] }, "put": { "operationId": "Update Membership Offer", "parameters": [ { "name": "offer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniUpdateMembershipOfferRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniUpdateMembershipOfferResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ] }, "delete": { "operationId": "Delete Membership Offer", "parameters": [ { "name": "offer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniEmptyRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniDeleteMembershipOfferResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ] } }, "/memberships/programs": { "get": { "operationId": "List Membership Programs", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniEmptyRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetMembershipProgramsResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] }, "post": { "operationId": "Create Membership Program", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniCreateMembershipProgramRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniCreateMembershipProgramResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] } }, "/memberships/definitions/{definition}": { "get": { "operationId": "Get Membership Definition", "parameters": [ { "name": "definition", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniEmptyRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetMembershipDefinitionResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ] }, "put": { "operationId": "Update Membership Definition", "parameters": [ { "name": "definition", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniUpdateMembershipDefinitionRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniUpdateMembershipDefinitionResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ] }, "delete": { "operationId": "Delete Membership Definition", "parameters": [ { "name": "definition", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniEmptyRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniDeleteMembershipDefinitionResponse" } } } } }, "security": [ { "davos-Membership-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ] } }, "/events/health": { "get": { "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bikekibikekC9gDEiy59QN2" } } } } }, "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] } }, "/events/events": { "post": { "operationId": "Post Events", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniIngestEventRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniIngestEventResponse" } } } } }, "security": [ { "bikekingdom-Event-authorizer-develop": [ "api/m2m", "tenant/bikekingdom" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] } }, "/events/events/query": { "post": { "operationId": "Query Events", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniQueryEventsRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniQueryEventsResponse" } } } } }, "security": [ { "bikekingdom-Event-authorizer-develop": [ "api/m2m", "tenant/bikekingdom" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] } }, "/events/subscriptions": { "get": { "operationId": "List Subscriptions", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetSubscriptionsRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetSubscriptionsResponse" } } } } }, "security": [ { "bikekingdom-Event-authorizer-develop": [ "api/m2m", "tenant/bikekingdom" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] }, "post": { "operationId": "Create Subscription", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniCreateSubscriptionRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniCreateSubscriptionResponse" } } } } }, "security": [ { "bikekingdom-Event-authorizer-develop": [ "api/m2m", "tenant/bikekingdom" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] } }, "/events/subscriptions/{subscription}": { "get": { "operationId": "Get Subscription", "parameters": [ { "name": "subscription", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetSubscriptionRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetSubscriptionResponse" } } } } }, "security": [ { "bikekingdom-Event-authorizer-develop": [ "api/m2m", "tenant/bikekingdom" ] } ] }, "put": { "operationId": "Update Subscription", "parameters": [ { "name": "subscription", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniUpdateSubscriptionRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniUpdateSubscriptionResponse" } } } } }, "security": [ { "bikekingdom-Event-authorizer-develop": [ "api/m2m", "tenant/bikekingdom" ] } ] }, "delete": { "operationId": "Delete Subscription", "parameters": [ { "name": "subscription", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniDeleteSubscriptionRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniDeleteSubscriptionResponse" } } } } }, "security": [ { "bikekingdom-Event-authorizer-develop": [ "api/m2m", "tenant/bikekingdom" ] } ] } }, "/events/": {}, "/braze/messages/schedule": { "post": { "operationId": "Schedule Message", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniScheduleEngagementMessageRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniScheduleEngagementMessageResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] } }, "/braze/events": {}, "/braze/users/{user}/attributes": { "put": { "operationId": "Update User Attributes", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniUpdateEngagementUserAttributesRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniUpdateEngagementUserAttributesResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ] } }, "/braze/segments/{segment}/users": { "get": { "operationId": "Get Segment Users", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "string" } }, { "name": "segment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementSegmentUsersResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ] } }, "/braze/email/unsubscribes": { "get": { "operationId": "Get Email Unsubscribes", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementEmailUnsubscribesResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ] } }, "/braze/templates/{template}": { "get": { "operationId": "Get Template", "parameters": [ { "name": "template", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementTemplateResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ] }, "put": { "operationId": "Update Template", "parameters": [ { "name": "template", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniUpdateEngagementTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniUpdateEngagementTemplateResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ] }, "delete": { "operationId": "Delete Template", "parameters": [ { "name": "template", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniDeleteEngagementTemplateResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ] } }, "/braze/segments/{segment}/analytics": { "get": { "operationId": "Get Segment Analytics", "parameters": [ { "name": "granularity", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "segment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementSegmentAnalyticsResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ] } }, "/braze/campaigns/{campaign}/analytics": { "get": { "operationId": "Get Campaign Analytics", "parameters": [ { "name": "granularity", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "campaign", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementCampaignAnalyticsResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ] } }, "/braze/campaigns/{campaign}": { "get": { "operationId": "Get Campaign", "parameters": [ { "name": "campaign", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementCampaignResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ] } }, "/braze/email/bounces": { "get": { "operationId": "Get Email Bounces", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementEmailBouncesResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ] } }, "/braze/users/{user}/export": { "post": { "operationId": "Export User Data", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniExportEngagementUserDataRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniExportEngagementUserDataResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ] } }, "/braze/users": {}, "/braze/email/bounces/remove": { "post": { "operationId": "Remove Email Bounce", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniRemoveEngagementEmailBounceRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniRemoveEngagementEmailBounceResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] } }, "/braze/segments/{segment}": { "get": { "operationId": "Get Segment", "parameters": [ { "name": "segment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementSegmentResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ] } }, "/braze/messages/send": { "post": { "operationId": "Send Message", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniSendEngagementMessageRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniSendEngagementMessageResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] } }, "/braze/messages/scheduled": { "get": { "operationId": "Get Scheduled Messages", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementScheduledMessagesResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ] } }, "/braze/campaigns": { "get": { "operationId": "Get Campaigns", "parameters": [ { "name": "sortOrder", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "string" } }, { "name": "lastEditedAfter", "in": "query", "schema": { "type": "string" } }, { "name": "tags", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementCampaignsResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ] } }, "/braze/users/{user}/canvases": { "get": { "operationId": "Get User Canvases", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementUserCanvasesResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ] } }, "/braze/users/{user}/events": { "get": { "operationId": "Get User Events", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "eventType", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementUserEventsResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ] } }, "/braze/campaigns/{campaign}/trigger": { "post": { "operationId": "Trigger Campaign", "parameters": [ { "name": "campaign", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniTriggerEngagementCampaignRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniTriggerEngagementCampaignResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ] } }, "/braze/users/{user}": { "delete": { "operationId": "Delete User Data", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniDeleteEngagementUserDataResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ] } }, "/braze/users/{user}/campaigns": { "get": { "operationId": "Get User Campaigns", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementUserCampaignsResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ] } }, "/braze/email/spam/remove": { "post": { "operationId": "Remove Email Spam", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniRemoveEngagementEmailSpamRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniRemoveEngagementEmailSpamResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] } }, "/braze/": {}, "/braze/segments": { "get": { "operationId": "Get Segments", "parameters": [ { "name": "sortOrder", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementSegmentsResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ] } }, "/braze/templates": { "get": { "operationId": "Get Templates", "parameters": [ { "name": "sortOrder", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "tags", "in": "query", "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementTemplatesResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ] }, "post": { "operationId": "Create Template", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniCreateEngagementTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniCreateEngagementTemplateResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] } }, "/braze/users/{user}/profile": { "get": { "operationId": "Get User Profile", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementUserProfileResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ] } }, "/braze/health": { "get": { "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/estmbestmBnUpDX8CcsV0V" } } } } }, "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] } }, "/braze/campaigns/{campaign}/sends": { "get": { "operationId": "Get Campaign Sends", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "string" } }, { "name": "campaign", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementCampaignSendsResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ] } }, "/braze/email/spam": {}, "/braze/email": {}, "/braze/messages/scheduled/{schedule}": { "put": { "operationId": "Update Scheduled Message", "parameters": [ { "name": "schedule", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniUpdateEngagementScheduledMessageRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniUpdateEngagementScheduledMessageResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ] }, "delete": { "operationId": "Cancel Scheduled Message", "parameters": [ { "name": "schedule", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniCancelEngagementScheduledMessageResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ] } }, "/braze/messages": {}, "/braze/users/{user}/segments": { "get": { "operationId": "Get User Segments", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementUserSegmentsResponse" } } } } }, "security": [ { "estm-braze-authorizer-develop": [ "api/m2m", "tenant/estm" ] } ] } }, "/feratel/health": { "get": { "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alFeralFerBPGKHAQ7P4vO" } } } } }, "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] } }, "/feratel/memberships/activate": { "post": { "operationId": "Activate Membership", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniActivateFeratelMembershipRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniActivateFeratelMembershipResponse" } } } } }, "security": [ { "al-Feratel-authorizer-develop": [ "api/m2m", "tenant/al" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] } }, "/feratel/memberships": { "get": { "operationId": "Get Memberships", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniEmptyRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetFeratelMembershipsResponse" } } } } }, "security": [ { "al-Feratel-authorizer-develop": [ "api/m2m", "tenant/al" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] }, "post": { "operationId": "Grant Membership", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGrantFeratelMembershipRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGrantFeratelMembershipResponse" } } } } }, "security": [ { "al-Feratel-authorizer-develop": [ "api/m2m", "tenant/al" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] }, "delete": { "operationId": "Revoke Membership", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniRevokeFeratelMembershipRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniRevokeFeratelMembershipResponse" } } } } }, "security": [ { "al-Feratel-authorizer-develop": [ "api/m2m", "tenant/al" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] } }, "/feratel/": {}, "/engagement/segments/{segment}": { "get": { "operationId": "Get Engagement Segment", "parameters": [ { "name": "segment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementSegmentResponse" } } } } }, "security": [ { "golm-Engagement-authorizer-develop": [ "api/m2m", "tenant/golm" ] } ] } }, "/engagement/users": {}, "/engagement/messages/scheduled": { "get": { "operationId": "Get Scheduled Messages", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementScheduledMessagesResponse" } } } } }, "security": [ { "golm-Engagement-authorizer-develop": [ "api/m2m", "tenant/golm" ] } ] } }, "/engagement/campaigns": { "get": { "operationId": "List Engagement Campaigns", "parameters": [ { "name": "sortOrder", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "string" } }, { "name": "lastEditedAfter", "in": "query", "schema": { "type": "string" } }, { "name": "tags", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementCampaignsResponse" } } } } }, "security": [ { "golm-Engagement-authorizer-develop": [ "api/m2m", "tenant/golm" ] } ] } }, "/engagement/segments/{segment}/users": { "get": { "operationId": "Get Segment Users", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "string" } }, { "name": "segment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementSegmentUsersResponse" } } } } }, "security": [ { "golm-Engagement-authorizer-develop": [ "api/m2m", "tenant/golm" ] } ] } }, "/engagement/users/{user}/events": { "get": { "operationId": "Get User Events", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "eventType", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementUserEventsResponse" } } } } }, "security": [ { "golm-Engagement-authorizer-develop": [ "api/m2m", "tenant/golm" ] } ] } }, "/engagement/users/{user}/canvases": { "get": { "operationId": "Get User Canvases", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementUserCanvasesResponse" } } } } }, "security": [ { "golm-Engagement-authorizer-develop": [ "api/m2m", "tenant/golm" ] } ] } }, "/engagement/email/unsubscribes": { "get": { "operationId": "Get Email Unsubscribes", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementEmailUnsubscribesResponse" } } } } }, "security": [ { "golm-Engagement-authorizer-develop": [ "api/m2m", "tenant/golm" ] } ] } }, "/engagement/users/{user}": {}, "/engagement/users/{user}/campaigns": { "get": { "operationId": "Get User Campaigns", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementUserCampaignsResponse" } } } } }, "security": [ { "golm-Engagement-authorizer-develop": [ "api/m2m", "tenant/golm" ] } ] } }, "/engagement/segments/{segment}/analytics": { "get": { "operationId": "Get Segment Analytics", "parameters": [ { "name": "granularity", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "segment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementSegmentAnalyticsResponse" } } } } }, "security": [ { "golm-Engagement-authorizer-develop": [ "api/m2m", "tenant/golm" ] } ] } }, "/engagement/": {}, "/engagement/segments": { "get": { "operationId": "List Engagement Segments", "parameters": [ { "name": "sortOrder", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementSegmentsResponse" } } } } }, "security": [ { "golm-Engagement-authorizer-develop": [ "api/m2m", "tenant/golm" ] } ] } }, "/engagement/users/{user}/profile": { "get": { "operationId": "Get User Profile", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementUserProfileResponse" } } } } }, "security": [ { "golm-Engagement-authorizer-develop": [ "api/m2m", "tenant/golm" ] } ] } }, "/engagement/campaigns/{campaign}/analytics": { "get": { "operationId": "Get Campaign Analytics", "parameters": [ { "name": "granularity", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "campaign", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementCampaignAnalyticsResponse" } } } } }, "security": [ { "golm-Engagement-authorizer-develop": [ "api/m2m", "tenant/golm" ] } ] } }, "/engagement/email/bounces": { "get": { "operationId": "Get Email Bounces", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementEmailBouncesResponse" } } } } }, "security": [ { "golm-Engagement-authorizer-develop": [ "api/m2m", "tenant/golm" ] } ] } }, "/engagement/health": { "get": { "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/golmEgolmEF7L918D4l5ZW" } } } } }, "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] } }, "/engagement/campaigns/{campaign}": { "get": { "operationId": "Get Engagement Campaign", "parameters": [ { "name": "campaign", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementCampaignResponse" } } } } }, "security": [ { "golm-Engagement-authorizer-develop": [ "api/m2m", "tenant/golm" ] } ] } }, "/engagement/campaigns/{campaign}/sends": { "get": { "operationId": "Get Campaign Sends", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "string" } }, { "name": "campaign", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementCampaignSendsResponse" } } } } }, "security": [ { "golm-Engagement-authorizer-develop": [ "api/m2m", "tenant/golm" ] } ] } }, "/engagement/email": {}, "/engagement/messages": {}, "/engagement/users/{user}/segments": { "get": { "operationId": "Get User Segments", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementUserSegmentsResponse" } } } } }, "security": [ { "golm-Engagement-authorizer-develop": [ "api/m2m", "tenant/golm" ] } ] } }, "/braze/users/{user}/devices": { "get": { "operationId": "Get User Devices", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetEngagementUserDevicesResponse" } } } } }, "security": [ { "al-braze-authorizer-develop": [ "api/m2m", "tenant/al" ] } ] } }, "/spot/health": { "get": { "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/davosdavosJICawQAriFFj" } } } } }, "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] } }, "/spot/events": { "post": { "operationId": "Post SPOT Events", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniPostSpotEventRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniPostSpotEventResponse" } } } } }, "security": [ { "davos-Spot-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] } }, "/spot/memberships/activate": { "post": { "operationId": "Activate Membership", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniActivateSpotMembershipRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniActivateSpotMembershipResponse" } } } } }, "security": [ { "davos-Spot-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] } }, "/spot/memberships": { "get": { "operationId": "Get Memberships", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniEmptyRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGetSpotMembershipsResponse" } } } } }, "security": [ { "davos-Spot-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] }, "post": { "operationId": "Grant Membership", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGrantSpotMembershipRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniGrantSpotMembershipResponse" } } } } }, "security": [ { "davos-Spot-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] }, "delete": { "operationId": "Revoke Membership", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniRevokeSpotMembershipRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniRevokeSpotMembershipResponse" } } } } }, "security": [ { "davos-Spot-authorizer-develop": [ "api/m2m", "tenant/davos" ] } ], "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] } }, "/spot/": {}, "/pricenow/health": { "get": { "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/laaxPlaaxPUnrWhoLr5tSj" } } } } }, "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] } }, "/pricenow/events": { "post": { "operationId": "Post Events", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniPostPriceNowEventRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniPostPriceNowEventResponse" } } } } }, "parameters": [ { "name": "x-omni-tenant", "in": "header", "required": true, "description": "Target tenant identifier", "schema": { "type": "string" } } ] } }, "/pricenow/": {} }, "components": { "schemas": { "sharedsharek7dskBQQVdPF": { "required": [ "response" ], "type": "object", "properties": { "response": { "type": "string" } } }, "OmniGetTokenResponse": { "required": [ "access_token", "expires_in", "token_type" ], "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "expires_in": { "type": "number" } }, "additionalProperties": false }, "OmniGetTokenRequest": { "required": [ "clientId", "clientSecret" ], "type": "object", "properties": { "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "tenant": { "type": "string" } }, "additionalProperties": false }, "OmniRevokeUserMembershipRequest": { "required": [ "membership", "user" ], "type": "object", "properties": { "membership": { "minLength": 1, "type": "string" }, "user": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "OmniGetMembershipCategoriesResponse": { "required": [ "categories" ], "type": "object", "properties": { "nextToken": { "type": "string" }, "categories": { "type": "array", "items": { "required": [ "created", "id", "tenant", "title", "updated" ], "type": "object", "properties": { "archived": { "type": "boolean", "default": false }, "archivedAt": { "type": "string", "format": "date-time" }, "images": { "type": "array", "items": { "type": "string" } }, "created": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "title": { "type": "object", "additionalProperties": { "type": "string" } }, "updated": { "type": "string", "format": "date-time" }, "tenant": { "minLength": 1, "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "OmniGrantUserMembershipResponse": { "required": [ "id", "membershipDefinitionId", "status", "universalUserId" ], "type": "object", "properties": { "universalUserId": { "type": "string" }, "id": { "type": "string" }, "membershipDefinitionId": { "type": "string" }, "status": { "type": "string" } }, "additionalProperties": false }, "OmniUpdateMembershipProviderResponse": { "required": [ "created", "id", "tenant", "title", "updated" ], "type": "object", "properties": { "archived": { "type": "boolean", "default": false }, "archivedAt": { "type": "string", "format": "date-time" }, "website": { "type": "string" }, "phone": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "title": { "type": "object", "additionalProperties": { "type": "string" } }, "updated": { "type": "string", "format": "date-time" }, "tenant": { "minLength": 1, "type": "string" }, "email": { "type": "string" } }, "additionalProperties": false }, "OmniUpdateMembershipCategoryRequest": { "required": [ "category" ], "type": "object", "properties": { "images": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "category": { "minLength": 1, "type": "string" }, "title": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "OmniActivateUserMembershipRequest": { "required": [ "birthday", "number", "user" ], "type": "object", "properties": { "birthday": { "minLength": 1, "type": "string" }, "number": { "minLength": 1, "type": "string" }, "membershipDefinitionId": { "minLength": 1, "type": "string" }, "user": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "OmniDeleteMembershipDefinitionResponse": { "required": [ "archived", "archivedAt", "id" ], "type": "object", "properties": { "archived": { "type": "boolean" }, "archivedAt": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "additionalProperties": false }, "alMemalMemjbYh1cPUo5sF": { "required": [ "response" ], "type": "object", "properties": { "response": { "type": "string" } } }, "OmniCreateMembershipProgramResponse": { "required": [ "created", "icon", "id", "memberships", "shortDescription", "tenant", "title", "updated" ], "type": "object", "properties": { "created": { "type": "string", "format": "date-time" }, "icon": { "type": "string" }, "shortDescription": { "type": "object", "additionalProperties": { "type": "string" } }, "title": { "type": "object", "additionalProperties": { "type": "string" } }, "priority": { "type": "number" }, "memberships": { "type": "array", "items": { "type": "string" } }, "archived": { "type": "boolean", "default": false }, "archivedAt": { "type": "string", "format": "date-time" }, "multipleActiveMembershipsAllowed": { "type": "boolean" }, "id": { "minLength": 1, "type": "string" }, "isMembershipProgramHidden": { "type": "boolean" }, "updated": { "type": "string", "format": "date-time" }, "tenant": { "minLength": 1, "type": "string" }, "programLandingDetail": { "required": [ "landingDescription", "landingTitle" ], "type": "object", "properties": { "landingTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "landingDescription": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false } }, "additionalProperties": false }, "OmniGetMembershipCategoryResponse": { "required": [ "created", "id", "tenant", "title", "updated" ], "type": "object", "properties": { "archived": { "type": "boolean", "default": false }, "archivedAt": { "type": "string", "format": "date-time" }, "images": { "type": "array", "items": { "type": "string" } }, "created": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "title": { "type": "object", "additionalProperties": { "type": "string" } }, "updated": { "type": "string", "format": "date-time" }, "tenant": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "OmniUpdateMembershipProgramRequest": { "required": [ "program" ], "type": "object", "properties": { "multipleActiveMembershipsAllowed": { "type": "boolean" }, "icon": { "type": "string" }, "program": { "minLength": 1, "type": "string" }, "isMembershipProgramHidden": { "type": "boolean" }, "shortDescription": { "type": "object", "additionalProperties": { "type": "string" } }, "title": { "type": "object", "additionalProperties": { "type": "string" } }, "priority": { "type": "number" }, "memberships": { "type": "array", "items": { "type": "string" } }, "programLandingDetail": { "required": [ "landingDescription", "landingTitle" ], "type": "object", "properties": { "landingTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "landingDescription": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false } }, "additionalProperties": false }, "OmniCreateMembershipOfferRequest": { "required": [ "claimFrequency", "images", "provider", "redemptionTimeLimitInMinutes", "supportedMemberships", "title" ], "type": "object", "properties": { "summary": { "type": "object", "additionalProperties": { "type": "string" } }, "private": { "type": "boolean" }, "images": { "type": "array", "items": { "type": "string" } }, "searchKeywords": { "type": "array", "items": { "type": "string" } }, "redemptionTimeLimitInMinutes": { "type": "number" }, "description": { "type": "string" }, "availability": { "type": "array", "items": { "required": [ "end", "start" ], "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "poi": { "type": "string" }, "title": { "type": "object", "additionalProperties": { "type": "string" } }, "termsAndConditions": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "deepLinkUrl": { "type": "string" }, "availabilityWeekDays": { "type": "array", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6", "7" ] } }, "supportedMemberships": { "type": "array", "items": { "type": "string" } }, "claimFrequency": { "type": "string", "enum": [ "DAILY", "WEEKLY", "UNLIMITED", "ONE_TIME" ] }, "provider": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "OmniEmptyRequest": { "type": "object", "properties": {}, "additionalProperties": false, "description": "Empty request body - used for GET and DELETE endpoints that have no request payload" }, "OmniUpdateMembershipSettingsResponse": { "required": [ "created", "id", "permissionRequestAddress", "tenant", "updated" ], "type": "object", "properties": { "created": { "type": "string", "format": "date-time" }, "id": { "minLength": 1, "type": "string" }, "permissionRequestAddress": { "type": "string" }, "updated": { "type": "string", "format": "date-time" }, "tenant": { "minLength": 1, "type": "string" }, "providers": { "type": "array", "items": { "required": [ "membershipEndpoint", "providerApiBaseUrl", "providerDomain", "providerName" ], "type": "object", "properties": { "userPoolTitle": { "type": "string" }, "clientName": { "type": "string" }, "enabled": { "type": "boolean", "default": true }, "providerApiBaseUrl": { "minLength": 1, "type": "string" }, "tokenEndpoint": { "minLength": 1, "type": "string" }, "m2mScope": { "type": "string", "default": "api/m2m" }, "sourceType": { "type": "string", "enum": [ "external", "internal" ], "default": "external" }, "m2mClientId": { "type": "string" }, "providerDomain": { "minLength": 1, "type": "string" }, "membershipEndpoint": { "minLength": 1, "type": "string" }, "activationEndpoint": { "minLength": 1, "type": "string" }, "m2mClientSecret": { "type": "string" }, "providerName": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "default": [] } }, "additionalProperties": false }, "OmniDeleteMembershipProviderResponse": { "required": [ "archived", "archivedAt", "id" ], "type": "object", "properties": { "archived": { "type": "boolean" }, "archivedAt": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "additionalProperties": false }, "OmniUpdateMembershipOfferResponse": { "required": [ "claimFrequency", "created", "id", "images", "provider", "redemptionTimeLimitInMinutes", "supportedMemberships", "tenant", "title", "updated" ], "type": "object", "properties": { "summary": { "type": "object", "additionalProperties": { "type": "string" } }, "private": { "type": "boolean" }, "images": { "type": "array", "items": { "type": "string" } }, "searchKeywords": { "type": "array", "items": { "type": "string" } }, "redemptionTimeLimitInMinutes": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "availability": { "type": "array", "items": { "required": [ "end", "start" ], "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "poi": { "type": "string" }, "title": { "type": "object", "additionalProperties": { "type": "string" } }, "termsAndConditions": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "deepLinkUrl": { "type": "string" }, "availabilityWeekDays": { "type": "array", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6", "7" ] } }, "archived": { "type": "boolean", "default": false }, "archivedAt": { "type": "string", "format": "date-time" }, "supportedMemberships": { "type": "array", "items": { "type": "string" } }, "claimFrequency": { "type": "string", "enum": [ "DAILY", "WEEKLY", "UNLIMITED", "ONE_TIME" ] }, "provider": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "updated": { "type": "string", "format": "date-time" }, "tenant": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "OmniActivateUserMembershipResponse": { "required": [ "activated", "number", "universalUserId" ], "type": "object", "properties": { "number": { "type": "string" }, "universalUserId": { "type": "string" }, "activated": { "type": "boolean" } }, "additionalProperties": false }, "OmniDeleteMembershipCategoryResponse": { "required": [ "archived", "archivedAt", "id" ], "type": "object", "properties": { "archived": { "type": "boolean" }, "archivedAt": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "additionalProperties": false }, "OmniGetMembershipProgramsResponse": { "required": [ "programs" ], "type": "object", "properties": { "nextToken": { "type": "string" }, "programs": { "type": "array", "items": { "required": [ "created", "icon", "id", "memberships", "shortDescription", "tenant", "title", "updated" ], "type": "object", "properties": { "created": { "type": "string", "format": "date-time" }, "icon": { "type": "string" }, "shortDescription": { "type": "object", "additionalProperties": { "type": "string" } }, "title": { "type": "object", "additionalProperties": { "type": "string" } }, "priority": { "type": "number" }, "memberships": { "type": "array", "items": { "type": "string" } }, "archived": { "type": "boolean", "default": false }, "archivedAt": { "type": "string", "format": "date-time" }, "multipleActiveMembershipsAllowed": { "type": "boolean" }, "id": { "minLength": 1, "type": "string" }, "isMembershipProgramHidden": { "type": "boolean" }, "updated": { "type": "string", "format": "date-time" }, "tenant": { "minLength": 1, "type": "string" }, "programLandingDetail": { "required": [ "landingDescription", "landingTitle" ], "type": "object", "properties": { "landingTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "landingDescription": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false } }, "additionalProperties": false } } }, "additionalProperties": false }, "OmniCreateMembershipProviderResponse": { "required": [ "created", "id", "tenant", "title", "updated" ], "type": "object", "properties": { "archived": { "type": "boolean", "default": false }, "archivedAt": { "type": "string", "format": "date-time" }, "website": { "type": "string" }, "phone": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "title": { "type": "object", "additionalProperties": { "type": "string" } }, "updated": { "type": "string", "format": "date-time" }, "tenant": { "minLength": 1, "type": "string" }, "email": { "type": "string" } }, "additionalProperties": false }, "OmniGetMembershipDefinitionsResponse": { "required": [ "definitions" ], "type": "object", "properties": { "nextToken": { "type": "string" }, "definitions": { "type": "array", "items": { "required": [ "cardImage", "created", "dateRange", "description", "disabledCardImage", "id", "inputFields", "priority", "submissionType", "tenant", "title", "type", "updated" ], "type": "object", "properties": { "cardImage": { "type": "string" }, "disabledCardImage": { "type": "string" }, "dateRange": { "type": "array", "items": { "required": [ "end", "start" ], "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "created": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "title": { "type": "object", "additionalProperties": { "type": "string" } }, "type": { "type": "string", "enum": [ "GUEST_CARD" ] }, "priority": { "type": "number" }, "tags": { "type": "array", "items": { "type": "string" } }, "inputFields": { "type": "array", "items": { "required": [ "label", "name", "placeholder" ], "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false } }, "submissionType": { "type": "string", "enum": [ "APPLICATION", "CODE", "EVENT_BASED", "SPOT" ] }, "codeInputContent": { "required": [ "qrCodeScanInfographicImage", "title" ], "type": "object", "properties": { "codeInputFieldPlaceholder": { "type": "object", "additionalProperties": { "type": "string" } }, "enterCodeTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "inputFieldsDescription": { "type": "object", "additionalProperties": { "type": "string" } }, "enterCodeHelpText": { "type": "object", "additionalProperties": { "type": "string" } }, "enterCodeDescription": { "type": "object", "additionalProperties": { "type": "string" } }, "codeInputFieldLabel": { "type": "object", "additionalProperties": { "type": "string" } }, "title": { "type": "string" }, "inputFieldsTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "qrCodeScanInfographicImage": { "type": "string" } }, "additionalProperties": false }, "archived": { "type": "boolean", "default": false }, "archivedAt": { "type": "string", "format": "date-time" }, "membershipActiveInactiveStateDetails": { "type": "object", "properties": { "membershipInactiveTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "membershipActiveTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "membershipInactiveDescription": { "type": "object", "additionalProperties": { "type": "string" } }, "membershipActiveDescription": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "id": { "minLength": 1, "type": "string" }, "updated": { "type": "string", "format": "date-time" }, "tenant": { "minLength": 1, "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "OmniCreateMembershipCategoryResponse": { "required": [ "created", "id", "tenant", "title", "updated" ], "type": "object", "properties": { "archived": { "type": "boolean", "default": false }, "archivedAt": { "type": "string", "format": "date-time" }, "images": { "type": "array", "items": { "type": "string" } }, "created": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "title": { "type": "object", "additionalProperties": { "type": "string" } }, "updated": { "type": "string", "format": "date-time" }, "tenant": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "OmniCreateMembershipOfferResponse": { "required": [ "claimFrequency", "created", "id", "images", "provider", "redemptionTimeLimitInMinutes", "supportedMemberships", "tenant", "title", "updated" ], "type": "object", "properties": { "summary": { "type": "object", "additionalProperties": { "type": "string" } }, "private": { "type": "boolean" }, "images": { "type": "array", "items": { "type": "string" } }, "searchKeywords": { "type": "array", "items": { "type": "string" } }, "redemptionTimeLimitInMinutes": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "availability": { "type": "array", "items": { "required": [ "end", "start" ], "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "poi": { "type": "string" }, "title": { "type": "object", "additionalProperties": { "type": "string" } }, "termsAndConditions": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "deepLinkUrl": { "type": "string" }, "availabilityWeekDays": { "type": "array", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6", "7" ] } }, "archived": { "type": "boolean", "default": false }, "archivedAt": { "type": "string", "format": "date-time" }, "supportedMemberships": { "type": "array", "items": { "type": "string" } }, "claimFrequency": { "type": "string", "enum": [ "DAILY", "WEEKLY", "UNLIMITED", "ONE_TIME" ] }, "provider": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "updated": { "type": "string", "format": "date-time" }, "tenant": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "OmniDeleteMembershipOfferResponse": { "required": [ "archived", "archivedAt", "id" ], "type": "object", "properties": { "archived": { "type": "boolean" }, "archivedAt": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "additionalProperties": false }, "OmniGetMembershipProgramResponse": { "required": [ "created", "icon", "id", "memberships", "shortDescription", "tenant", "title", "updated" ], "type": "object", "properties": { "created": { "type": "string", "format": "date-time" }, "icon": { "type": "string" }, "shortDescription": { "type": "object", "additionalProperties": { "type": "string" } }, "title": { "type": "object", "additionalProperties": { "type": "string" } }, "priority": { "type": "number" }, "memberships": { "type": "array", "items": { "type": "string" } }, "archived": { "type": "boolean", "default": false }, "archivedAt": { "type": "string", "format": "date-time" }, "multipleActiveMembershipsAllowed": { "type": "boolean" }, "id": { "minLength": 1, "type": "string" }, "isMembershipProgramHidden": { "type": "boolean" }, "updated": { "type": "string", "format": "date-time" }, "tenant": { "minLength": 1, "type": "string" }, "programLandingDetail": { "required": [ "landingDescription", "landingTitle" ], "type": "object", "properties": { "landingTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "landingDescription": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false } }, "additionalProperties": false }, "OmniGetMembershipOfferResponse": { "required": [ "claimFrequency", "created", "id", "images", "provider", "redemptionTimeLimitInMinutes", "supportedMemberships", "tenant", "title", "updated" ], "type": "object", "properties": { "summary": { "type": "object", "additionalProperties": { "type": "string" } }, "private": { "type": "boolean" }, "images": { "type": "array", "items": { "type": "string" } }, "searchKeywords": { "type": "array", "items": { "type": "string" } }, "redemptionTimeLimitInMinutes": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "availability": { "type": "array", "items": { "required": [ "end", "start" ], "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "poi": { "type": "string" }, "title": { "type": "object", "additionalProperties": { "type": "string" } }, "termsAndConditions": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "deepLinkUrl": { "type": "string" }, "availabilityWeekDays": { "type": "array", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6", "7" ] } }, "archived": { "type": "boolean", "default": false }, "archivedAt": { "type": "string", "format": "date-time" }, "supportedMemberships": { "type": "array", "items": { "type": "string" } }, "claimFrequency": { "type": "string", "enum": [ "DAILY", "WEEKLY", "UNLIMITED", "ONE_TIME" ] }, "provider": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "updated": { "type": "string", "format": "date-time" }, "tenant": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "OmniUpdateMembershipOfferRequest": { "required": [ "offer" ], "type": "object", "properties": { "summary": { "type": "object", "additionalProperties": { "type": "string" } }, "private": { "type": "boolean" }, "images": { "type": "array", "items": { "type": "string" } }, "searchKeywords": { "type": "array", "items": { "type": "string" } }, "redemptionTimeLimitInMinutes": { "type": "number" }, "description": { "type": "string" }, "availability": { "type": "array", "items": { "required": [ "end", "start" ], "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "poi": { "type": "string" }, "title": { "type": "object", "additionalProperties": { "type": "string" } }, "termsAndConditions": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "offer": { "minLength": 1, "type": "string" }, "deepLinkUrl": { "type": "string" }, "availabilityWeekDays": { "type": "array", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6", "7" ] } }, "supportedMemberships": { "type": "array", "items": { "type": "string" } }, "claimFrequency": { "type": "string", "enum": [ "DAILY", "WEEKLY", "UNLIMITED", "ONE_TIME" ] }, "provider": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "OmniCreateMembershipProgramRequest": { "required": [ "icon", "memberships", "shortDescription", "title" ], "type": "object", "properties": { "multipleActiveMembershipsAllowed": { "type": "boolean" }, "icon": { "type": "string" }, "isMembershipProgramHidden": { "type": "boolean" }, "shortDescription": { "type": "object", "additionalProperties": { "type": "string" } }, "title": { "type": "object", "additionalProperties": { "type": "string" } }, "priority": { "type": "number" }, "memberships": { "type": "array", "items": { "type": "string" } }, "programLandingDetail": { "required": [ "landingDescription", "landingTitle" ], "type": "object", "properties": { "landingTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "landingDescription": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false } }, "additionalProperties": false }, "OmniDeleteMembershipProgramResponse": { "required": [ "archived", "archivedAt", "id" ], "type": "object", "properties": { "archived": { "type": "boolean" }, "archivedAt": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "additionalProperties": false }, "OmniRevokeUserMembershipResponse": { "required": [ "id", "membershipDefinitionId", "status", "universalUserId" ], "type": "object", "properties": { "universalUserId": { "type": "string" }, "id": { "type": "string" }, "membershipDefinitionId": { "type": "string" }, "status": { "type": "string" } }, "additionalProperties": false }, "OmniUpdateMembershipDefinitionRequest": { "required": [ "definition" ], "type": "object", "properties": { "cardImage": { "type": "string" }, "disabledCardImage": { "type": "string" }, "dateRange": { "type": "array", "items": { "required": [ "end", "start" ], "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "description": { "type": "string" }, "title": { "type": "object", "additionalProperties": { "type": "string" } }, "type": { "type": "string", "enum": [ "GUEST_CARD" ] }, "priority": { "type": "number" }, "tags": { "type": "array", "items": { "type": "string" } }, "inputFields": { "type": "array", "items": { "required": [ "label", "name", "placeholder" ], "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false } }, "submissionType": { "type": "string", "enum": [ "APPLICATION", "CODE", "EVENT_BASED", "SPOT" ] }, "codeInputContent": { "required": [ "qrCodeScanInfographicImage", "title" ], "type": "object", "properties": { "codeInputFieldPlaceholder": { "type": "object", "additionalProperties": { "type": "string" } }, "enterCodeTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "inputFieldsDescription": { "type": "object", "additionalProperties": { "type": "string" } }, "enterCodeHelpText": { "type": "object", "additionalProperties": { "type": "string" } }, "enterCodeDescription": { "type": "object", "additionalProperties": { "type": "string" } }, "codeInputFieldLabel": { "type": "object", "additionalProperties": { "type": "string" } }, "title": { "type": "string" }, "inputFieldsTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "qrCodeScanInfographicImage": { "type": "string" } }, "additionalProperties": false }, "membershipActiveInactiveStateDetails": { "type": "object", "properties": { "membershipInactiveTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "membershipActiveTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "membershipInactiveDescription": { "type": "object", "additionalProperties": { "type": "string" } }, "membershipActiveDescription": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "definition": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "OmniGetMembershipProvidersResponse": { "required": [ "providers" ], "type": "object", "properties": { "nextToken": { "type": "string" }, "providers": { "type": "array", "items": { "required": [ "created", "id", "tenant", "title", "updated" ], "type": "object", "properties": { "archived": { "type": "boolean", "default": false }, "archivedAt": { "type": "string", "format": "date-time" }, "website": { "type": "string" }, "phone": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "title": { "type": "object", "additionalProperties": { "type": "string" } }, "updated": { "type": "string", "format": "date-time" }, "tenant": { "minLength": 1, "type": "string" }, "email": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "OmniUpdateMembershipCategoryResponse": { "required": [ "created", "id", "tenant", "title", "updated" ], "type": "object", "properties": { "archived": { "type": "boolean", "default": false }, "archivedAt": { "type": "string", "format": "date-time" }, "images": { "type": "array", "items": { "type": "string" } }, "created": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "title": { "type": "object", "additionalProperties": { "type": "string" } }, "updated": { "type": "string", "format": "date-time" }, "tenant": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "OmniUpdateMembershipSettingsRequest": { "type": "object", "properties": { "permissionRequestAddress": { "type": "string" }, "providers": { "type": "array", "items": { "required": [ "membershipEndpoint", "providerApiBaseUrl", "providerDomain", "providerName" ], "type": "object", "properties": { "userPoolTitle": { "type": "string" }, "clientName": { "type": "string" }, "enabled": { "type": "boolean", "default": true }, "providerApiBaseUrl": { "minLength": 1, "type": "string" }, "tokenEndpoint": { "minLength": 1, "type": "string" }, "m2mScope": { "type": "string", "default": "api/m2m" }, "sourceType": { "type": "string", "enum": [ "external", "internal" ], "default": "external" }, "m2mClientId": { "type": "string" }, "providerDomain": { "minLength": 1, "type": "string" }, "membershipEndpoint": { "minLength": 1, "type": "string" }, "activationEndpoint": { "minLength": 1, "type": "string" }, "m2mClientSecret": { "type": "string" }, "providerName": { "minLength": 1, "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "OmniUpdateMembershipProgramResponse": { "required": [ "created", "icon", "id", "memberships", "shortDescription", "tenant", "title", "updated" ], "type": "object", "properties": { "created": { "type": "string", "format": "date-time" }, "icon": { "type": "string" }, "shortDescription": { "type": "object", "additionalProperties": { "type": "string" } }, "title": { "type": "object", "additionalProperties": { "type": "string" } }, "priority": { "type": "number" }, "memberships": { "type": "array", "items": { "type": "string" } }, "archived": { "type": "boolean", "default": false }, "archivedAt": { "type": "string", "format": "date-time" }, "multipleActiveMembershipsAllowed": { "type": "boolean" }, "id": { "minLength": 1, "type": "string" }, "isMembershipProgramHidden": { "type": "boolean" }, "updated": { "type": "string", "format": "date-time" }, "tenant": { "minLength": 1, "type": "string" }, "programLandingDetail": { "required": [ "landingDescription", "landingTitle" ], "type": "object", "properties": { "landingTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "landingDescription": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false } }, "additionalProperties": false }, "OmniGetMembershipProviderResponse": { "required": [ "created", "id", "tenant", "title", "updated" ], "type": "object", "properties": { "archived": { "type": "boolean", "default": false }, "archivedAt": { "type": "string", "format": "date-time" }, "website": { "type": "string" }, "phone": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "title": { "type": "object", "additionalProperties": { "type": "string" } }, "updated": { "type": "string", "format": "date-time" }, "tenant": { "minLength": 1, "type": "string" }, "email": { "type": "string" } }, "additionalProperties": false }, "OmniGrantUserMembershipRequest": { "required": [ "membershipDefinitionId", "provider", "providerMembershipId", "user" ], "type": "object", "properties": { "birthday": { "type": "string" }, "providerMembershipId": { "minLength": 1, "type": "string" }, "lastName": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": { "type": "object" } }, "ticket": { "type": "string" }, "ticketType": { "type": "string" }, "membershipDefinitionId": { "minLength": 1, "type": "string" }, "validFrom": { "type": "string", "format": "date-time" }, "serviceName": { "type": "string" }, "firstName": { "type": "string" }, "provider": { "minLength": 1, "type": "string" }, "validUntil": { "type": "string", "format": "date-time" }, "user": { "minLength": 1, "type": "string" }, "cardNumber": { "type": "integer" } }, "additionalProperties": false }, "OmniGetMembershipDefinitionResponse": { "required": [ "cardImage", "created", "dateRange", "description", "disabledCardImage", "id", "inputFields", "priority", "submissionType", "tenant", "title", "type", "updated" ], "type": "object", "properties": { "cardImage": { "type": "string" }, "disabledCardImage": { "type": "string" }, "dateRange": { "type": "array", "items": { "required": [ "end", "start" ], "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "created": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "title": { "type": "object", "additionalProperties": { "type": "string" } }, "type": { "type": "string", "enum": [ "GUEST_CARD" ] }, "priority": { "type": "number" }, "tags": { "type": "array", "items": { "type": "string" } }, "inputFields": { "type": "array", "items": { "required": [ "label", "name", "placeholder" ], "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false } }, "submissionType": { "type": "string", "enum": [ "APPLICATION", "CODE", "EVENT_BASED", "SPOT" ] }, "codeInputContent": { "required": [ "qrCodeScanInfographicImage", "title" ], "type": "object", "properties": { "codeInputFieldPlaceholder": { "type": "object", "additionalProperties": { "type": "string" } }, "enterCodeTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "inputFieldsDescription": { "type": "object", "additionalProperties": { "type": "string" } }, "enterCodeHelpText": { "type": "object", "additionalProperties": { "type": "string" } }, "enterCodeDescription": { "type": "object", "additionalProperties": { "type": "string" } }, "codeInputFieldLabel": { "type": "object", "additionalProperties": { "type": "string" } }, "title": { "type": "string" }, "inputFieldsTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "qrCodeScanInfographicImage": { "type": "string" } }, "additionalProperties": false }, "archived": { "type": "boolean", "default": false }, "archivedAt": { "type": "string", "format": "date-time" }, "membershipActiveInactiveStateDetails": { "type": "object", "properties": { "membershipInactiveTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "membershipActiveTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "membershipInactiveDescription": { "type": "object", "additionalProperties": { "type": "string" } }, "membershipActiveDescription": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "id": { "minLength": 1, "type": "string" }, "updated": { "type": "string", "format": "date-time" }, "tenant": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "OmniUpdateMembershipDefinitionResponse": { "required": [ "cardImage", "created", "dateRange", "description", "disabledCardImage", "id", "inputFields", "priority", "submissionType", "tenant", "title", "type", "updated" ], "type": "object", "properties": { "cardImage": { "type": "string" }, "disabledCardImage": { "type": "string" }, "dateRange": { "type": "array", "items": { "required": [ "end", "start" ], "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "created": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "title": { "type": "object", "additionalProperties": { "type": "string" } }, "type": { "type": "string", "enum": [ "GUEST_CARD" ] }, "priority": { "type": "number" }, "tags": { "type": "array", "items": { "type": "string" } }, "inputFields": { "type": "array", "items": { "required": [ "label", "name", "placeholder" ], "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false } }, "submissionType": { "type": "string", "enum": [ "APPLICATION", "CODE", "EVENT_BASED", "SPOT" ] }, "codeInputContent": { "required": [ "qrCodeScanInfographicImage", "title" ], "type": "object", "properties": { "codeInputFieldPlaceholder": { "type": "object", "additionalProperties": { "type": "string" } }, "enterCodeTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "inputFieldsDescription": { "type": "object", "additionalProperties": { "type": "string" } }, "enterCodeHelpText": { "type": "object", "additionalProperties": { "type": "string" } }, "enterCodeDescription": { "type": "object", "additionalProperties": { "type": "string" } }, "codeInputFieldLabel": { "type": "object", "additionalProperties": { "type": "string" } }, "title": { "type": "string" }, "inputFieldsTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "qrCodeScanInfographicImage": { "type": "string" } }, "additionalProperties": false }, "archived": { "type": "boolean", "default": false }, "archivedAt": { "type": "string", "format": "date-time" }, "membershipActiveInactiveStateDetails": { "type": "object", "properties": { "membershipInactiveTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "membershipActiveTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "membershipInactiveDescription": { "type": "object", "additionalProperties": { "type": "string" } }, "membershipActiveDescription": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "id": { "minLength": 1, "type": "string" }, "updated": { "type": "string", "format": "date-time" }, "tenant": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "OmniCreateMembershipCategoryRequest": { "required": [ "title" ], "type": "object", "properties": { "images": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "title": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "OmniGetTenantUserMembershipsResponse": { "required": [ "memberships" ], "type": "object", "properties": { "nextToken": { "type": "string" }, "memberships": { "type": "array", "items": { "required": [ "id", "membershipDefinitionId", "provider", "providerMembershipId", "status", "tenant", "universalUserId" ], "type": "object", "properties": { "birthday": { "type": "string" }, "providerMembershipId": { "minLength": 1, "type": "string" }, "lastName": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": { "type": "object" } }, "ticket": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "ticketType": { "type": "string" }, "membershipDefinitionId": { "minLength": 1, "type": "string" }, "validFrom": { "type": "string", "format": "date-time" }, "serviceName": { "type": "string" }, "revokeReason": { "type": "string" }, "submissionType": { "type": "string" }, "firstName": { "type": "string" }, "universalUserId": { "minLength": 1, "type": "string" }, "passes": { "type": "array", "items": { "anyOf": [ { "required": [ "passType", "passUrl" ], "type": "object", "properties": { "passType": { "type": "string", "enum": [ "pkpass" ] }, "passUrl": { "type": "string", "format": "uri" } }, "additionalProperties": false }, { "required": [ "passType", "passUrl" ], "type": "object", "properties": { "passType": { "type": "string", "enum": [ "googleWallet" ] }, "passUrl": { "type": "string", "format": "uri" } }, "additionalProperties": false }, { "required": [ "passType", "passUrl" ], "type": "object", "properties": { "passType": { "type": "string", "enum": [ "web" ] }, "passUrl": { "type": "string", "format": "uri" } }, "additionalProperties": false }, { "required": [ "passType", "passUrl" ], "type": "object", "properties": { "passType": { "type": "string", "enum": [ "pdf" ] }, "passUrl": { "type": "string", "format": "uri" } }, "additionalProperties": false } ] } }, "provider": { "minLength": 1, "type": "string" }, "validUntil": { "type": "string", "format": "date-time" }, "id": { "minLength": 1, "type": "string" }, "grantedAt": { "type": "string", "format": "date-time" }, "revokedAt": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "tenant": { "minLength": 1, "type": "string" }, "cardNumber": { "type": "integer" }, "status": { "type": "string", "enum": [ "active", "expired", "revoked", "cancelled" ] } }, "additionalProperties": false } } }, "additionalProperties": false }, "OmniCreateMembershipDefinitionRequest": { "required": [ "cardImage", "dateRange", "description", "disabledCardImage", "inputFields", "priority", "submissionType", "title", "type" ], "type": "object", "properties": { "inputFields": { "type": "array", "items": { "required": [ "label", "name", "placeholder" ], "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false } }, "cardImage": { "type": "string" }, "submissionType": { "type": "string", "enum": [ "APPLICATION", "CODE", "EVENT_BASED", "SPOT" ] }, "codeInputContent": { "required": [ "qrCodeScanInfographicImage", "title" ], "type": "object", "properties": { "codeInputFieldPlaceholder": { "type": "object", "additionalProperties": { "type": "string" } }, "enterCodeTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "inputFieldsDescription": { "type": "object", "additionalProperties": { "type": "string" } }, "enterCodeHelpText": { "type": "object", "additionalProperties": { "type": "string" } }, "enterCodeDescription": { "type": "object", "additionalProperties": { "type": "string" } }, "codeInputFieldLabel": { "type": "object", "additionalProperties": { "type": "string" } }, "title": { "type": "string" }, "inputFieldsTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "qrCodeScanInfographicImage": { "type": "string" } }, "additionalProperties": false }, "membershipActiveInactiveStateDetails": { "type": "object", "properties": { "membershipInactiveTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "membershipActiveTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "membershipInactiveDescription": { "type": "object", "additionalProperties": { "type": "string" } }, "membershipActiveDescription": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "disabledCardImage": { "type": "string" }, "dateRange": { "type": "array", "items": { "required": [ "end", "start" ], "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "description": { "type": "string" }, "title": { "type": "object", "additionalProperties": { "type": "string" } }, "type": { "type": "string", "enum": [ "GUEST_CARD" ] }, "priority": { "type": "number" }, "tags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "OmniCreateMembershipProviderRequest": { "required": [ "title" ], "type": "object", "properties": { "website": { "type": "string" }, "phone": { "type": "string" }, "description": { "type": "string" }, "title": { "type": "object", "additionalProperties": { "type": "string" } }, "email": { "type": "string" } }, "additionalProperties": false }, "OmniGetUserMembershipsResponse": { "required": [ "memberships" ], "type": "object", "properties": { "nextToken": { "type": "string" }, "memberships": { "type": "array", "items": { "required": [ "id", "membershipDefinitionId", "provider", "providerMembershipId", "status", "tenant", "universalUserId" ], "type": "object", "properties": { "birthday": { "type": "string" }, "providerMembershipId": { "minLength": 1, "type": "string" }, "lastName": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": { "type": "object" } }, "ticket": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "ticketType": { "type": "string" }, "membershipDefinitionId": { "minLength": 1, "type": "string" }, "validFrom": { "type": "string", "format": "date-time" }, "serviceName": { "type": "string" }, "revokeReason": { "type": "string" }, "submissionType": { "type": "string" }, "firstName": { "type": "string" }, "universalUserId": { "minLength": 1, "type": "string" }, "passes": { "type": "array", "items": { "anyOf": [ { "required": [ "passType", "passUrl" ], "type": "object", "properties": { "passType": { "type": "string", "enum": [ "pkpass" ] }, "passUrl": { "type": "string", "format": "uri" } }, "additionalProperties": false }, { "required": [ "passType", "passUrl" ], "type": "object", "properties": { "passType": { "type": "string", "enum": [ "googleWallet" ] }, "passUrl": { "type": "string", "format": "uri" } }, "additionalProperties": false }, { "required": [ "passType", "passUrl" ], "type": "object", "properties": { "passType": { "type": "string", "enum": [ "web" ] }, "passUrl": { "type": "string", "format": "uri" } }, "additionalProperties": false }, { "required": [ "passType", "passUrl" ], "type": "object", "properties": { "passType": { "type": "string", "enum": [ "pdf" ] }, "passUrl": { "type": "string", "format": "uri" } }, "additionalProperties": false } ] } }, "provider": { "minLength": 1, "type": "string" }, "validUntil": { "type": "string", "format": "date-time" }, "id": { "minLength": 1, "type": "string" }, "grantedAt": { "type": "string", "format": "date-time" }, "revokedAt": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "tenant": { "minLength": 1, "type": "string" }, "cardNumber": { "type": "integer" }, "status": { "type": "string", "enum": [ "active", "expired", "revoked", "cancelled" ] } }, "additionalProperties": false } } }, "additionalProperties": false }, "OmniCreateMembershipDefinitionResponse": { "required": [ "cardImage", "created", "dateRange", "description", "disabledCardImage", "id", "inputFields", "priority", "submissionType", "tenant", "title", "type", "updated" ], "type": "object", "properties": { "cardImage": { "type": "string" }, "disabledCardImage": { "type": "string" }, "dateRange": { "type": "array", "items": { "required": [ "end", "start" ], "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "created": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "title": { "type": "object", "additionalProperties": { "type": "string" } }, "type": { "type": "string", "enum": [ "GUEST_CARD" ] }, "priority": { "type": "number" }, "tags": { "type": "array", "items": { "type": "string" } }, "inputFields": { "type": "array", "items": { "required": [ "label", "name", "placeholder" ], "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false } }, "submissionType": { "type": "string", "enum": [ "APPLICATION", "CODE", "EVENT_BASED", "SPOT" ] }, "codeInputContent": { "required": [ "qrCodeScanInfographicImage", "title" ], "type": "object", "properties": { "codeInputFieldPlaceholder": { "type": "object", "additionalProperties": { "type": "string" } }, "enterCodeTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "inputFieldsDescription": { "type": "object", "additionalProperties": { "type": "string" } }, "enterCodeHelpText": { "type": "object", "additionalProperties": { "type": "string" } }, "enterCodeDescription": { "type": "object", "additionalProperties": { "type": "string" } }, "codeInputFieldLabel": { "type": "object", "additionalProperties": { "type": "string" } }, "title": { "type": "string" }, "inputFieldsTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "qrCodeScanInfographicImage": { "type": "string" } }, "additionalProperties": false }, "archived": { "type": "boolean", "default": false }, "archivedAt": { "type": "string", "format": "date-time" }, "membershipActiveInactiveStateDetails": { "type": "object", "properties": { "membershipInactiveTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "membershipActiveTitle": { "type": "object", "additionalProperties": { "type": "string" } }, "membershipInactiveDescription": { "type": "object", "additionalProperties": { "type": "string" } }, "membershipActiveDescription": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "id": { "minLength": 1, "type": "string" }, "updated": { "type": "string", "format": "date-time" }, "tenant": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "OmniGetMembershipSettingsResponse": { "required": [ "created", "id", "permissionRequestAddress", "tenant", "updated" ], "type": "object", "properties": { "created": { "type": "string", "format": "date-time" }, "id": { "minLength": 1, "type": "string" }, "permissionRequestAddress": { "type": "string" }, "updated": { "type": "string", "format": "date-time" }, "tenant": { "minLength": 1, "type": "string" }, "providers": { "type": "array", "items": { "required": [ "membershipEndpoint", "providerApiBaseUrl", "providerDomain", "providerName" ], "type": "object", "properties": { "userPoolTitle": { "type": "string" }, "clientName": { "type": "string" }, "enabled": { "type": "boolean", "default": true }, "providerApiBaseUrl": { "minLength": 1, "type": "string" }, "tokenEndpoint": { "minLength": 1, "type": "string" }, "m2mScope": { "type": "string", "default": "api/m2m" }, "sourceType": { "type": "string", "enum": [ "external", "internal" ], "default": "external" }, "m2mClientId": { "type": "string" }, "providerDomain": { "minLength": 1, "type": "string" }, "membershipEndpoint": { "minLength": 1, "type": "string" }, "activationEndpoint": { "minLength": 1, "type": "string" }, "m2mClientSecret": { "type": "string" }, "providerName": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "default": [] } }, "additionalProperties": false }, "OmniGetMembershipOffersResponse": { "required": [ "offers" ], "type": "object", "properties": { "offers": { "type": "array", "items": { "required": [ "claimFrequency", "created", "id", "images", "provider", "redemptionTimeLimitInMinutes", "supportedMemberships", "tenant", "title", "updated" ], "type": "object", "properties": { "summary": { "type": "object", "additionalProperties": { "type": "string" } }, "private": { "type": "boolean" }, "images": { "type": "array", "items": { "type": "string" } }, "searchKeywords": { "type": "array", "items": { "type": "string" } }, "redemptionTimeLimitInMinutes": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "availability": { "type": "array", "items": { "required": [ "end", "start" ], "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "poi": { "type": "string" }, "title": { "type": "object", "additionalProperties": { "type": "string" } }, "termsAndConditions": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "deepLinkUrl": { "type": "string" }, "availabilityWeekDays": { "type": "array", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6", "7" ] } }, "archived": { "type": "boolean", "default": false }, "archivedAt": { "type": "string", "format": "date-time" }, "supportedMemberships": { "type": "array", "items": { "type": "string" } }, "claimFrequency": { "type": "string", "enum": [ "DAILY", "WEEKLY", "UNLIMITED", "ONE_TIME" ] }, "provider": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "updated": { "type": "string", "format": "date-time" }, "tenant": { "minLength": 1, "type": "string" } }, "additionalProperties": false } }, "nextToken": { "type": "string" } }, "additionalProperties": false }, "OmniUpdateMembershipProviderRequest": { "required": [ "provider" ], "type": "object", "properties": { "website": { "type": "string" }, "provider": { "minLength": 1, "type": "string" }, "phone": { "type": "string" }, "description": { "type": "string" }, "title": { "type": "object", "additionalProperties": { "type": "string" } }, "email": { "type": "string" } }, "additionalProperties": false }, "OmniCreateSubscriptionRequest": { "required": [ "events", "url" ], "type": "object", "properties": { "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "url": { "type": "string", "format": "uri" }, "events": { "minItems": 1, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "additionalProperties": false }, "OmniDeleteSubscriptionRequest": { "required": [ "subscription" ], "type": "object", "properties": { "subscription": { "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "type": "string" } }, "additionalProperties": false }, "OmniUpdateSubscriptionResponse": { "required": [ "createdAt", "events", "id", "subscriptionId", "tenant", "updatedAt", "url" ], "type": "object", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "id": { "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "type": "string" }, "subscriptionId": { "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "type": "string" }, "tenant": { "minLength": 1, "type": "string" }, "url": { "type": "string", "format": "uri" }, "events": { "type": "array", "items": { "minLength": 1, "type": "string" } }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "OmniCreateSubscriptionResponse": { "required": [ "subscriptionId" ], "type": "object", "properties": { "subscriptionId": { "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "type": "string" } }, "additionalProperties": false }, "OmniGetSubscriptionsRequest": { "type": "object", "properties": { "cursor": { "type": "string" }, "limit": { "maximum": 100, "minimum": 1, "type": "number", "default": 20 }, "status": { "type": "string", "enum": [ "active", "paused", "disabled" ] } }, "additionalProperties": false }, "OmniGetSubscriptionResponse": { "required": [ "createdAt", "events", "id", "subscriptionId", "tenant", "updatedAt", "url" ], "type": "object", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "id": { "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "type": "string" }, "subscriptionId": { "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "type": "string" }, "tenant": { "minLength": 1, "type": "string" }, "url": { "type": "string", "format": "uri" }, "events": { "type": "array", "items": { "minLength": 1, "type": "string" } }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "OmniQueryEventsResponse": { "required": [ "data", "rows" ], "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "rows": { "type": "number" }, "statistics": { "required": [ "bytes_read", "elapsed", "rows_read" ], "type": "object", "properties": { "elapsed": { "type": "number" }, "rows_read": { "type": "number" }, "bytes_read": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, "OmniDeleteSubscriptionResponse": { "required": [ "deleted", "subscriptionId" ], "type": "object", "properties": { "deleted": { "type": "boolean" }, "subscriptionId": { "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "type": "string" } }, "additionalProperties": false }, "OmniGetSubscriptionsResponse": { "required": [ "subscriptions" ], "type": "object", "properties": { "subscriptions": { "type": "array", "items": { "required": [ "createdAt", "events", "id", "subscriptionId", "tenant", "updatedAt", "url" ], "type": "object", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "id": { "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "type": "string" }, "subscriptionId": { "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "type": "string" }, "tenant": { "minLength": 1, "type": "string" }, "url": { "type": "string", "format": "uri" }, "events": { "type": "array", "items": { "minLength": 1, "type": "string" } }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "nextToken": { "type": "string" } }, "additionalProperties": false }, "OmniIngestEventRequest": { "required": [ "events" ], "type": "object", "properties": { "version": { "type": "string", "default": "1.0" }, "events": { "maxItems": 10000, "minItems": 1, "type": "array", "items": { "required": [ "eventType", "payload", "source", "tenant", "timestamp" ], "type": "object", "properties": { "metadata": { "type": "object", "properties": { "version": { "type": "string", "default": "1.0" } }, "additionalProperties": true }, "provider": { "minLength": 1, "type": "string" }, "payload": { "type": "object", "properties": {}, "additionalProperties": true }, "source": { "maxLength": 256, "minLength": 1, "type": "string" }, "eventType": { "maxLength": 200, "minLength": 1, "pattern": "^[a-z0-9]+(?:\\.[a-z0-9]+)*$", "type": "string" }, "userId": { "type": "string" }, "tenant": { "minLength": 1, "type": "string" }, "timestamp": { "type": "string", "format": "date-time" } }, "additionalProperties": false } } }, "additionalProperties": false }, "OmniQueryEventsRequest": { "required": [ "sql" ], "type": "object", "properties": { "format": { "type": "string", "enum": [ "JSON", "JSONEachRow", "CSV" ], "default": "JSONEachRow" }, "sql": { "maxLength": 10000, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "insideinsidOMq3M2vzeMTK": { "required": [ "response" ], "type": "object", "properties": { "response": { "type": "string" } } }, "OmniIngestEventResponse": { "required": [ "accepted", "eventIds", "rejected" ], "type": "object", "properties": { "rejected": { "type": "number" }, "accepted": { "type": "number" }, "eventIds": { "type": "array", "items": { "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "type": "string" } } }, "additionalProperties": false }, "OmniUpdateSubscriptionRequest": { "required": [ "subscription" ], "type": "object", "properties": { "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "subscription": { "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "type": "string" }, "url": { "type": "string", "format": "uri" }, "events": { "minItems": 1, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "additionalProperties": false }, "OmniGetSubscriptionRequest": { "required": [ "subscription" ], "type": "object", "properties": { "subscription": { "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "type": "string" } }, "additionalProperties": false }, "alEvealEveVvx1J6CekNIH": { "required": [ "response" ], "type": "object", "properties": { "response": { "type": "string" } } }, "golmEgolmE86iBy4HHIequ": { "required": [ "response" ], "type": "object", "properties": { "response": { "type": "string" } } }, "davosdavosE55eWl5jZmjk": { "required": [ "response" ], "type": "object", "properties": { "response": { "type": "string" } } }, "alpincalpinQXXbiUJ2qelk": { "required": [ "response" ], "type": "object", "properties": { "response": { "type": "string" } } }, "OmniUpdateEngagementTemplateRequest": { "required": [ "template" ], "type": "object", "properties": { "template": { "minLength": 1, "type": "string" }, "subject": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string", "enum": [ "email", "push", "sms", "whatsapp" ] }, "body": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "OmniGetEngagementTemplatesResponse": { "required": [ "limit", "page", "templates", "totalCount" ], "type": "object", "properties": { "templates": { "type": "array", "items": { "required": [ "id", "name", "type" ], "type": "object", "properties": { "subject": { "type": "string" }, "created": { "minLength": 1, "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "type": { "type": "string", "enum": [ "email", "push", "sms", "whatsapp" ] }, "body": { "type": "string" }, "updated": { "minLength": 1, "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "limit": { "minimum": 1, "type": "integer", "description": "Maximum number of items returned per page" }, "page": { "minimum": 0, "type": "integer", "description": "Zero-indexed page number returned" }, "totalCount": { "minimum": 0, "type": "integer", "description": "Total number of items across all pages" } }, "additionalProperties": false }, "OmniCancelEngagementScheduledMessageResponse": { "required": [ "scheduleId", "status" ], "type": "object", "properties": { "scheduleId": { "type": "string" }, "status": { "type": "string", "enum": [ "cancelled", "failed" ] } }, "additionalProperties": false }, "OmniGetEngagementSegmentsResponse": { "required": [ "limit", "page", "segments", "totalCount" ], "type": "object", "properties": { "limit": { "minimum": 1, "type": "integer", "description": "Maximum number of items returned per page" }, "page": { "minimum": 0, "type": "integer", "description": "Zero-indexed page number returned" }, "totalCount": { "minimum": 0, "type": "integer", "description": "Total number of items across all pages" }, "segments": { "type": "array", "items": { "required": [ "id", "name" ], "type": "object", "properties": { "size": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "description": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "updated": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } } }, "additionalProperties": false }, "OmniRemoveEngagementEmailSpamResponse": { "required": [ "email", "removed" ], "type": "object", "properties": { "removed": { "type": "boolean" }, "email": { "type": "string", "format": "email" } }, "additionalProperties": false }, "OmniUpdateEngagementUserAttributesRequest": { "required": [ "user" ], "type": "object", "properties": { "user": { "minLength": 1, "type": "string" }, "customAttributes": { "type": "object" } }, "additionalProperties": false }, "OmniGetEngagementCampaignAnalyticsResponse": { "required": [ "campaignId", "period" ], "type": "object", "properties": { "timeSeries": { "type": "array", "items": { "required": [ "date" ], "type": "object", "properties": { "date": { "minLength": 1, "type": "string" }, "conversions": { "type": "number" }, "revenue": { "type": "number" }, "opens": { "type": "number" }, "clicks": { "type": "number" }, "delivered": { "type": "number" }, "sent": { "type": "number" } }, "additionalProperties": false } }, "period": { "required": [ "endDate", "startDate" ], "type": "object", "properties": { "endDate": { "type": "string", "format": "date-time" }, "startDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "campaignId": { "type": "string" }, "conversionMetrics": { "type": "object", "properties": { "conversions": { "type": "number" }, "revenue": { "type": "number" }, "currency": { "type": "string" }, "conversionRate": { "type": "number" } }, "additionalProperties": false }, "engagementMetrics": { "type": "object", "properties": { "openRate": { "type": "number" }, "uniqueOpens": { "type": "number" }, "unsubscribes": { "type": "number" }, "clickRate": { "type": "number" }, "opens": { "type": "number" }, "clicks": { "type": "number" }, "uniqueClicks": { "type": "number" } }, "additionalProperties": false }, "deliveryMetrics": { "type": "object", "properties": { "deliveryRate": { "type": "number" }, "delivered": { "type": "number" }, "bounced": { "type": "number" }, "sent": { "type": "number" } }, "additionalProperties": false }, "campaignName": { "type": "string" } }, "additionalProperties": false }, "OmniGetEngagementUserEventsResponse": { "required": [ "events", "totalCount" ], "type": "object", "properties": { "totalCount": { "type": "number" }, "events": { "type": "array", "items": { "required": [ "eventId", "eventType" ], "type": "object", "properties": { "eventId": { "type": "string" }, "eventType": { "type": "string" }, "properties": { "type": "object" }, "timestamp": { "type": "string", "format": "date-time" } }, "additionalProperties": false } } }, "additionalProperties": false }, "OmniCreateEngagementTemplateResponse": { "required": [ "id", "name", "type" ], "type": "object", "properties": { "subject": { "type": "string" }, "created": { "minLength": 1, "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "type": { "type": "string", "enum": [ "email", "push", "sms", "whatsapp" ] }, "body": { "type": "string" }, "updated": { "minLength": 1, "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "OmniGetEngagementTemplateResponse": { "required": [ "id", "name", "type" ], "type": "object", "properties": { "subject": { "type": "string" }, "created": { "minLength": 1, "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "type": { "type": "string", "enum": [ "email", "push", "sms", "whatsapp" ] }, "body": { "type": "string" }, "updated": { "minLength": 1, "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "OmniUpdateEngagementScheduledMessageRequest": { "required": [ "schedule" ], "type": "object", "properties": { "schedule": { "minLength": 1, "type": "string" }, "channels": { "type": "object", "properties": { "whatsapp": { "required": [ "templateName" ], "type": "object", "properties": { "templateName": { "type": "string" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "sms": { "required": [ "body" ], "type": "object", "properties": { "body": { "type": "string" } }, "additionalProperties": false }, "email": { "required": [ "subject" ], "type": "object", "properties": { "subject": { "type": "string" }, "body": { "type": "string" }, "templateId": { "type": "string" } }, "additionalProperties": false }, "push": { "required": [ "body", "title" ], "type": "object", "properties": { "deepLink": { "type": "string" }, "imageUrl": { "type": "string" }, "title": { "type": "string" }, "body": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "scheduledAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "OmniGetEngagementEmailBouncesResponse": { "required": [ "bounces", "limit", "page", "totalCount" ], "type": "object", "properties": { "limit": { "minimum": 1, "type": "integer", "description": "Maximum number of items returned per page" }, "bounces": { "type": "array", "items": { "required": [ "email" ], "type": "object", "properties": { "bounceType": { "type": "string", "enum": [ "hard", "soft" ] }, "bouncedAt": { "type": "string", "format": "date-time" }, "email": { "type": "string", "format": "email" } }, "additionalProperties": false } }, "page": { "minimum": 0, "type": "integer", "description": "Zero-indexed page number returned" }, "totalCount": { "minimum": 0, "type": "integer", "description": "Total number of items across all pages" } }, "additionalProperties": false }, "OmniTriggerEngagementCampaignRequest": { "required": [ "campaign" ], "type": "object", "properties": { "userIds": { "type": "array", "items": { "type": "string" } }, "segmentId": { "type": "string" }, "triggerProperties": { "type": "object" }, "campaign": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "OmniScheduleEngagementMessageRequest": { "required": [ "channels", "scheduledAt" ], "type": "object", "properties": { "channels": { "type": "object", "properties": { "whatsapp": { "required": [ "templateName" ], "type": "object", "properties": { "templateName": { "type": "string" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "sms": { "required": [ "body" ], "type": "object", "properties": { "body": { "type": "string" } }, "additionalProperties": false }, "email": { "required": [ "subject" ], "type": "object", "properties": { "subject": { "type": "string" }, "body": { "type": "string" }, "templateId": { "type": "string" } }, "additionalProperties": false }, "push": { "required": [ "body", "title" ], "type": "object", "properties": { "deepLink": { "type": "string" }, "imageUrl": { "type": "string" }, "title": { "type": "string" }, "body": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "overrideFrequencyCapping": { "type": "boolean", "default": false }, "campaignId": { "type": "string" }, "userIds": { "type": "array", "items": { "type": "string" } }, "segmentId": { "type": "string" }, "scheduledAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "OmniGetEngagementUserCanvasesResponse": { "required": [ "canvases" ], "type": "object", "properties": { "canvases": { "type": "array", "items": { "required": [ "id", "name" ], "type": "object", "properties": { "totalConversions": { "type": "number" }, "lastEntry": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "description": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "totalEntries": { "type": "number" }, "firstEntry": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "active", "draft", "archived", "stopped" ] }, "tags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } } }, "additionalProperties": false }, "OmniGetEngagementUserCampaignsResponse": { "required": [ "campaigns" ], "type": "object", "properties": { "campaigns": { "type": "array", "items": { "required": [ "id", "name", "status" ], "type": "object", "properties": { "channels": { "type": "array", "items": { "type": "string", "enum": [ "email", "push", "sms", "whatsapp", "in_app", "content_card" ] } }, "isApiTriggered": { "type": "boolean" }, "scheduleType": { "type": "string", "enum": [ "immediate", "scheduled", "action_based", "api_triggered" ] }, "firstSent": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "description": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "lastSent": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "active", "draft", "archived", "stopped", "scheduled" ] }, "tags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } } }, "additionalProperties": false }, "OmniSendEngagementMessageRequest": { "required": [ "channels" ], "type": "object", "properties": { "channels": { "type": "object", "properties": { "whatsapp": { "required": [ "templateName" ], "type": "object", "properties": { "templateName": { "type": "string" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "sms": { "required": [ "body" ], "type": "object", "properties": { "body": { "type": "string" } }, "additionalProperties": false }, "email": { "required": [ "subject" ], "type": "object", "properties": { "subject": { "type": "string" }, "body": { "type": "string" }, "templateId": { "type": "string" } }, "additionalProperties": false }, "push": { "required": [ "body", "title" ], "type": "object", "properties": { "deepLink": { "type": "string" }, "imageUrl": { "type": "string" }, "title": { "type": "string" }, "body": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "overrideFrequencyCapping": { "type": "boolean", "default": false }, "campaignId": { "type": "string" }, "userIds": { "type": "array", "items": { "type": "string" } }, "segmentId": { "type": "string" } }, "additionalProperties": false }, "OmniGetEngagementCampaignSendsResponse": { "required": [ "limit", "page", "sends", "totalCount" ], "type": "object", "properties": { "limit": { "minimum": 1, "type": "integer", "description": "Maximum number of items returned per page" }, "page": { "minimum": 0, "type": "integer", "description": "Zero-indexed page number returned" }, "totalCount": { "minimum": 0, "type": "integer", "description": "Total number of items across all pages" }, "sends": { "type": "array", "items": { "required": [ "campaignId", "sendId" ], "type": "object", "properties": { "sendId": { "type": "string" }, "recipientCount": { "type": "number" }, "campaignId": { "type": "string" }, "sentAt": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "sent", "sending", "failed", "scheduled" ] } }, "additionalProperties": false } } }, "additionalProperties": false }, "OmniGetEngagementEmailUnsubscribesResponse": { "required": [ "limit", "page", "totalCount", "unsubscribes" ], "type": "object", "properties": { "unsubscribes": { "type": "array", "items": { "required": [ "email" ], "type": "object", "properties": { "unsubscribedAt": { "type": "string", "format": "date-time" }, "email": { "type": "string", "format": "email" } }, "additionalProperties": false } }, "limit": { "minimum": 1, "type": "integer", "description": "Maximum number of items returned per page" }, "page": { "minimum": 0, "type": "integer", "description": "Zero-indexed page number returned" }, "totalCount": { "minimum": 0, "type": "integer", "description": "Total number of items across all pages" } }, "additionalProperties": false }, "OmniRemoveEngagementEmailSpamRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string", "format": "email" } }, "additionalProperties": false }, "OmniUpdateEngagementUserAttributesResponse": { "required": [ "universalUserId" ], "type": "object", "properties": { "lastName": { "type": "string" }, "preferences": { "type": "object", "properties": { "pushOptIn": { "type": "boolean" }, "smsOptIn": { "type": "boolean" }, "emailOptIn": { "type": "boolean" }, "whatsappOptIn": { "type": "boolean" } }, "additionalProperties": false }, "lastActive": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time" }, "lifetimeValue": { "type": "number" }, "engagementScore": { "type": "number" }, "segments": { "type": "array", "items": { "required": [ "id", "name" ], "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false } }, "firstName": { "type": "string" }, "universalUserId": { "minLength": 1, "type": "string" }, "totalPurchases": { "type": "number" }, "currency": { "type": "string" }, "email": { "type": "string", "format": "email" }, "customAttributes": { "type": "object" } }, "additionalProperties": false }, "OmniTriggerEngagementCampaignResponse": { "required": [ "dispatchId", "status" ], "type": "object", "properties": { "dispatchId": { "type": "string" }, "status": { "type": "string", "enum": [ "sent", "queued", "failed" ] } }, "additionalProperties": false }, "OmniCreateEngagementTemplateRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "subject": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string", "enum": [ "email", "push", "sms", "whatsapp" ] }, "body": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "OmniGetEngagementSegmentResponse": { "required": [ "id", "name" ], "type": "object", "properties": { "size": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "description": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "updated": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "insideinsid1Wp4Y8ybJmrT": { "required": [ "response" ], "type": "object", "properties": { "response": { "type": "string" } } }, "OmniRemoveEngagementEmailBounceResponse": { "required": [ "email", "removed" ], "type": "object", "properties": { "removed": { "type": "boolean" }, "email": { "type": "string", "format": "email" } }, "additionalProperties": false }, "OmniDeleteEngagementTemplateResponse": { "required": [ "deleted", "id" ], "type": "object", "properties": { "deleted": { "type": "boolean" }, "id": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "OmniSendEngagementMessageResponse": { "required": [ "messageId", "status" ], "type": "object", "properties": { "messageId": { "type": "string" }, "errors": { "type": "array", "items": { "required": [ "channel", "error", "userId" ], "type": "object", "properties": { "channel": { "type": "string", "enum": [ "email", "push", "sms", "whatsapp", "in_app", "content_card" ] }, "error": { "type": "string" }, "userId": { "type": "string" } }, "additionalProperties": false } }, "dispatchId": { "type": "string" }, "status": { "type": "string", "enum": [ "sent", "queued", "failed" ] } }, "additionalProperties": false }, "OmniGetEngagementSegmentUsersResponse": { "required": [ "limit", "page", "totalCount", "users" ], "type": "object", "properties": { "limit": { "minimum": 1, "type": "integer", "description": "Maximum number of items returned per page" }, "page": { "minimum": 0, "type": "integer", "description": "Zero-indexed page number returned" }, "totalCount": { "minimum": 0, "type": "integer", "description": "Total number of items across all pages" }, "users": { "type": "array", "items": { "required": [ "universalUserId" ], "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "universalUserId": { "minLength": 1, "type": "string" }, "email": { "type": "string", "format": "email" } }, "additionalProperties": false } } }, "additionalProperties": false }, "OmniGetEngagementUserProfileResponse": { "required": [ "universalUserId" ], "type": "object", "properties": { "lastName": { "type": "string" }, "preferences": { "type": "object", "properties": { "pushOptIn": { "type": "boolean" }, "smsOptIn": { "type": "boolean" }, "emailOptIn": { "type": "boolean" }, "whatsappOptIn": { "type": "boolean" } }, "additionalProperties": false }, "lastActive": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time" }, "lifetimeValue": { "type": "number" }, "engagementScore": { "type": "number" }, "segments": { "type": "array", "items": { "required": [ "id", "name" ], "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false } }, "firstName": { "type": "string" }, "universalUserId": { "minLength": 1, "type": "string" }, "totalPurchases": { "type": "number" }, "currency": { "type": "string" }, "email": { "type": "string", "format": "email" }, "customAttributes": { "type": "object" } }, "additionalProperties": false }, "OmniUpdateEngagementScheduledMessageResponse": { "required": [ "scheduleId", "scheduledAt", "status" ], "type": "object", "properties": { "scheduleId": { "type": "string" }, "scheduledAt": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "scheduled", "updated", "failed" ] } }, "additionalProperties": false }, "OmniDeleteEngagementUserDataResponse": { "required": [ "status", "universalUserId" ], "type": "object", "properties": { "universalUserId": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "processing", "completed", "failed" ] }, "deletedProviders": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "OmniExportEngagementUserDataRequest": { "required": [ "user" ], "type": "object", "properties": { "purpose": { "type": "string", "enum": [ "user_request", "regulatory_compliance" ], "default": "user_request" }, "format": { "type": "string", "enum": [ "json", "csv" ], "default": "json" }, "user": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "OmniScheduleEngagementMessageResponse": { "required": [ "scheduleId", "scheduledAt", "status" ], "type": "object", "properties": { "scheduleId": { "type": "string" }, "scheduledAt": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "scheduled", "failed" ] } }, "additionalProperties": false }, "OmniExportEngagementUserDataResponse": { "required": [ "exportId", "status" ], "type": "object", "properties": { "estimatedCompletion": { "type": "string", "format": "date-time" }, "downloadUrl": { "type": "string", "format": "uri" }, "exportId": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "processing", "completed", "failed" ] } }, "additionalProperties": false }, "OmniGetEngagementScheduledMessagesResponse": { "required": [ "limit", "messages", "page", "totalCount" ], "type": "object", "properties": { "limit": { "minimum": 1, "type": "integer", "description": "Maximum number of items returned per page" }, "messages": { "type": "array", "items": { "required": [ "scheduleId", "scheduledAt", "status" ], "type": "object", "properties": { "campaignId": { "type": "string" }, "scheduleId": { "type": "string" }, "scheduledAt": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "scheduled", "sent", "cancelled", "failed" ] } }, "additionalProperties": false } }, "page": { "minimum": 0, "type": "integer", "description": "Zero-indexed page number returned" }, "totalCount": { "minimum": 0, "type": "integer", "description": "Total number of items across all pages" } }, "additionalProperties": false }, "OmniGetEngagementSegmentAnalyticsResponse": { "required": [ "segmentId" ], "type": "object", "properties": { "timeSeries": { "type": "array", "items": { "required": [ "date", "size" ], "type": "object", "properties": { "date": { "minLength": 1, "type": "string" }, "size": { "type": "number" } }, "additionalProperties": false } }, "segmentId": { "type": "string" } }, "additionalProperties": false }, "OmniGetEngagementCampaignResponse": { "required": [ "id", "name", "status" ], "type": "object", "properties": { "channels": { "type": "array", "items": { "type": "string", "enum": [ "email", "push", "sms", "whatsapp", "in_app", "content_card" ] } }, "isApiTriggered": { "type": "boolean" }, "scheduleType": { "type": "string", "enum": [ "immediate", "scheduled", "action_based", "api_triggered" ] }, "firstSent": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "description": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "lastSent": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "active", "draft", "archived", "stopped", "scheduled" ] }, "tags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "OmniUpdateEngagementTemplateResponse": { "required": [ "id", "name", "type" ], "type": "object", "properties": { "subject": { "type": "string" }, "created": { "minLength": 1, "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "type": { "type": "string", "enum": [ "email", "push", "sms", "whatsapp" ] }, "body": { "type": "string" }, "updated": { "minLength": 1, "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "OmniGetEngagementCampaignsResponse": { "required": [ "campaigns", "limit", "page", "totalCount" ], "type": "object", "properties": { "campaigns": { "type": "array", "items": { "required": [ "id", "name", "status" ], "type": "object", "properties": { "channels": { "type": "array", "items": { "type": "string", "enum": [ "email", "push", "sms", "whatsapp", "in_app", "content_card" ] } }, "isApiTriggered": { "type": "boolean" }, "scheduleType": { "type": "string", "enum": [ "immediate", "scheduled", "action_based", "api_triggered" ] }, "firstSent": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "description": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "lastSent": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "active", "draft", "archived", "stopped", "scheduled" ] }, "tags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "limit": { "minimum": 1, "type": "integer", "description": "Maximum number of items returned per page" }, "page": { "minimum": 0, "type": "integer", "description": "Zero-indexed page number returned" }, "totalCount": { "minimum": 0, "type": "integer", "description": "Total number of items across all pages" } }, "additionalProperties": false }, "OmniGetEngagementUserSegmentsResponse": { "required": [ "segments" ], "type": "object", "properties": { "segments": { "type": "array", "items": { "required": [ "id", "name" ], "type": "object", "properties": { "size": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "description": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "updated": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } } }, "additionalProperties": false }, "OmniRemoveEngagementEmailBounceRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string", "format": "email" } }, "additionalProperties": false }, "OmniGrantFeratelMembershipRequest": { "required": [ "email", "tenant" ], "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "tenant": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "OmniActivateFeratelMembershipResponse": { "required": [ "activated", "number", "universalUserId" ], "type": "object", "properties": { "number": { "type": "string" }, "universalUserId": { "type": "string" }, "activated": { "type": "boolean" } }, "additionalProperties": false }, "OmniActivateFeratelMembershipRequest": { "required": [ "birthday", "number", "user" ], "type": "object", "properties": { "birthday": { "minLength": 1, "type": "string" }, "number": { "minLength": 1, "type": "string" }, "membershipDefinitionId": { "minLength": 1, "type": "string" }, "user": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "OmniGrantFeratelMembershipResponse": { "required": [ "success" ], "type": "object", "properties": { "universalUserId": { "type": "string" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "OmniRevokeFeratelMembershipRequest": { "required": [ "email", "membershipId", "tenant" ], "type": "object", "properties": { "membershipId": { "minLength": 1, "type": "string" }, "email": { "type": "string", "format": "email" }, "tenant": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "OmniGetFeratelMembershipsResponse": { "required": [ "memberships" ], "type": "object", "properties": { "memberships": { "type": "array", "items": { "required": [ "id", "membershipDefinitionId", "provider", "providerMembershipId", "status", "tenant", "universalUserId" ], "type": "object", "properties": { "birthday": { "type": "string" }, "providerMembershipId": { "minLength": 1, "type": "string" }, "lastName": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": { "type": "object" } }, "ticket": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "ticketType": { "type": "string" }, "membershipDefinitionId": { "minLength": 1, "type": "string" }, "validFrom": { "type": "string", "format": "date-time" }, "serviceName": { "type": "string" }, "revokeReason": { "type": "string" }, "submissionType": { "type": "string" }, "firstName": { "type": "string" }, "universalUserId": { "minLength": 1, "type": "string" }, "passes": { "type": "array", "items": { "anyOf": [ { "required": [ "passType", "passUrl" ], "type": "object", "properties": { "passType": { "type": "string", "enum": [ "pkpass" ] }, "passUrl": { "type": "string", "format": "uri" } }, "additionalProperties": false }, { "required": [ "passType", "passUrl" ], "type": "object", "properties": { "passType": { "type": "string", "enum": [ "googleWallet" ] }, "passUrl": { "type": "string", "format": "uri" } }, "additionalProperties": false }, { "required": [ "passType", "passUrl" ], "type": "object", "properties": { "passType": { "type": "string", "enum": [ "web" ] }, "passUrl": { "type": "string", "format": "uri" } }, "additionalProperties": false }, { "required": [ "passType", "passUrl" ], "type": "object", "properties": { "passType": { "type": "string", "enum": [ "pdf" ] }, "passUrl": { "type": "string", "format": "uri" } }, "additionalProperties": false } ] } }, "provider": { "minLength": 1, "type": "string" }, "validUntil": { "type": "string", "format": "date-time" }, "id": { "minLength": 1, "type": "string" }, "grantedAt": { "type": "string", "format": "date-time" }, "revokedAt": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "tenant": { "minLength": 1, "type": "string" }, "cardNumber": { "type": "integer" }, "status": { "type": "string", "enum": [ "active", "expired", "revoked", "cancelled" ] } }, "additionalProperties": false } } }, "additionalProperties": false }, "alFeralFerBPGKHAQ7P4vO": { "required": [ "response" ], "type": "object", "properties": { "response": { "type": "string" } } }, "OmniRevokeFeratelMembershipResponse": { "required": [ "success" ], "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "golmEgolmEF7L918D4l5ZW": { "required": [ "response" ], "type": "object", "properties": { "response": { "type": "string" } } }, "laaxElaaxEszxjTxmbBQYQ": { "required": [ "response" ], "type": "object", "properties": { "response": { "type": "string" } } }, "laaxblaaxBsYxAZNI0tdIS": { "required": [ "response" ], "type": "object", "properties": { "response": { "type": "string" } } }, "OmniGetEngagementUserDevicesResponse": { "required": [ "apps", "devices", "universalUserId" ], "type": "object", "properties": { "universalUserId": { "type": "string" }, "devices": { "type": "array", "items": { "type": "object", "properties": { "googleAdId": { "type": "string" }, "carrier": { "type": "string" }, "windowsAdId": { "type": "string" }, "os": { "type": "string" }, "rokuAdId": { "type": "string" }, "adTrackingEnabled": { "type": "boolean" }, "idfa": { "type": "string" }, "model": { "type": "string" }, "idfv": { "type": "string" }, "deviceId": { "type": "string" } }, "additionalProperties": false } }, "apps": { "type": "array", "items": { "type": "object", "properties": { "lastUsed": { "type": "string" }, "sessions": { "type": "number" }, "firstUsed": { "type": "string" }, "name": { "type": "string" }, "version": { "type": "string" }, "platform": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "albraalBraAAN6rJcSM7oL": { "required": [ "response" ], "type": "object", "properties": { "response": { "type": "string" } } }, "golmbgolmB8vGWublCp8EL": { "required": [ "response" ], "type": "object", "properties": { "response": { "type": "string" } } }, "alpincalpinNro47K5QHznb": { "required": [ "response" ], "type": "object", "properties": { "response": { "type": "string" } } }, "bikekibikekYOZ8C33QY00F": { "required": [ "response" ], "type": "object", "properties": { "response": { "type": "string" } } }, "OmniPostSpotEventRequest": { "required": [ "events" ], "type": "object", "properties": { "events": { "minItems": 1, "type": "array", "description": "Batch of raw Spot event payloads to ingest", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "description": "Batch of raw Spot event payloads to ingest into S3" }, "davosdavosJICawQAriFFj": { "required": [ "response" ], "type": "object", "properties": { "response": { "type": "string" } } }, "OmniActivateSpotMembershipRequest": { "required": [ "birthday", "number", "user" ], "type": "object", "properties": { "birthday": { "minLength": 1, "type": "string" }, "number": { "minLength": 1, "type": "string" }, "membershipDefinitionId": { "minLength": 1, "type": "string" }, "user": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "OmniGetSpotMembershipsResponse": { "required": [ "memberships" ], "type": "object", "properties": { "memberships": { "type": "array", "items": { "required": [ "id", "membershipDefinitionId", "provider", "providerMembershipId", "status", "tenant", "universalUserId" ], "type": "object", "properties": { "birthday": { "type": "string" }, "providerMembershipId": { "minLength": 1, "type": "string" }, "lastName": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": { "type": "object" } }, "ticket": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "ticketType": { "type": "string" }, "membershipDefinitionId": { "minLength": 1, "type": "string" }, "validFrom": { "type": "string", "format": "date-time" }, "serviceName": { "type": "string" }, "revokeReason": { "type": "string" }, "submissionType": { "type": "string" }, "firstName": { "type": "string" }, "universalUserId": { "minLength": 1, "type": "string" }, "passes": { "type": "array", "items": { "anyOf": [ { "required": [ "passType", "passUrl" ], "type": "object", "properties": { "passType": { "type": "string", "enum": [ "pkpass" ] }, "passUrl": { "type": "string", "format": "uri" } }, "additionalProperties": false }, { "required": [ "passType", "passUrl" ], "type": "object", "properties": { "passType": { "type": "string", "enum": [ "googleWallet" ] }, "passUrl": { "type": "string", "format": "uri" } }, "additionalProperties": false }, { "required": [ "passType", "passUrl" ], "type": "object", "properties": { "passType": { "type": "string", "enum": [ "web" ] }, "passUrl": { "type": "string", "format": "uri" } }, "additionalProperties": false }, { "required": [ "passType", "passUrl" ], "type": "object", "properties": { "passType": { "type": "string", "enum": [ "pdf" ] }, "passUrl": { "type": "string", "format": "uri" } }, "additionalProperties": false } ] } }, "provider": { "minLength": 1, "type": "string" }, "validUntil": { "type": "string", "format": "date-time" }, "id": { "minLength": 1, "type": "string" }, "grantedAt": { "type": "string", "format": "date-time" }, "revokedAt": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "tenant": { "minLength": 1, "type": "string" }, "cardNumber": { "type": "integer" }, "status": { "type": "string", "enum": [ "active", "expired", "revoked", "cancelled" ] } }, "additionalProperties": false } } }, "additionalProperties": false }, "OmniRevokeSpotMembershipRequest": { "required": [ "email", "tenant", "userId" ], "type": "object", "properties": { "userId": { "minLength": 1, "type": "string" }, "email": { "type": "string", "format": "email" }, "tenant": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "OmniGrantSpotMembershipResponse": { "required": [ "success" ], "type": "object", "properties": { "universalUserId": { "type": "string" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "OmniActivateSpotMembershipResponse": { "required": [ "activated", "number", "universalUserId" ], "type": "object", "properties": { "number": { "type": "string" }, "universalUserId": { "type": "string" }, "activated": { "type": "boolean" } }, "additionalProperties": false }, "OmniRevokeSpotMembershipResponse": { "required": [ "success" ], "type": "object", "properties": { "universalUserId": { "type": "string" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "OmniGrantSpotMembershipRequest": { "required": [ "email", "tenant", "userId" ], "type": "object", "properties": { "userId": { "minLength": 1, "type": "string" }, "email": { "type": "string", "format": "email" }, "tenant": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "OmniPostSpotEventResponse": { "type": "boolean", "description": "Whether the events were successfully ingested" }, "davosdavosJZMkVNodXyHQ": { "required": [ "response" ], "type": "object", "properties": { "response": { "type": "string" } } }, "OmniPostPriceNowEventResponse": { "type": "boolean", "description": "Whether the events were successfully ingested" }, "golmPgolmP9bycKxQCcnNq": { "required": [ "response" ], "type": "object", "properties": { "response": { "type": "string" } } }, "OmniPostPriceNowEventRequest": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Batch of raw Price Now event payloads to ingest into S3" }, "laaxPlaaxPUnrWhoLr5tSj": { "required": [ "response" ], "type": "object", "properties": { "response": { "type": "string" } } }, "estmEestmEhR4hu4uotXlm": { "required": [ "response" ], "type": "object", "properties": { "response": { "type": "string" } } }, "estmbestmBnUpDX8CcsV0V": { "required": [ "response" ], "type": "object", "properties": { "response": { "type": "string" } } }, "bikekibikekC9gDEiy59QN2": { "required": [ "response" ], "type": "object", "properties": { "response": { "type": "string" } } } } } }