{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/zywave/main/json-schema/zywave-tool-package-response-schema.json",
  "title": "ToolPackageResponse",
  "description": "Client-facing tool package response. Feature keys are translated from the underlying\nGuid collection to the strongly-typed ToolPackageFeature enum; internal audit\nfields are excluded.",
  "x-generated": "2026-10-13",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/zywave-client-engagement-v3-openapi.json#/components/schemas/ToolPackageResponse",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "name"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "description": "The unique identifier of the tool package.",
      "format": "int32"
    },
    "name": {
      "type": "string",
      "description": "The name of the tool package.",
      "maxLength": 250,
      "minLength": 0
    },
    "agencyId": {
      "type": "integer",
      "description": "The agency that owns the tool package.",
      "format": "int32"
    },
    "portalId": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The portal this package is scoped to, if any.",
      "format": "int32"
    },
    "defaultMembership": {
      "type": "boolean",
      "description": "Whether new clients receive this package by default."
    },
    "allTools": {
      "type": "boolean",
      "description": "Whether the package grants access to all tools."
    },
    "allContent": {
      "type": "boolean",
      "description": "Whether the package grants access to all content."
    },
    "inactive": {
      "type": "boolean",
      "description": "Whether the package is inactive."
    },
    "features": {
      "type": "array",
      "description": "The features this tool package grants, resolved from the underlying feature keys.",
      "items": {
        "$ref": "#/$defs/ToolPackageFeature"
      }
    },
    "members": {
      "type": "array",
      "description": "Member assignments for this tool package (populated when the request asked to enrich members).",
      "items": {
        "$ref": "#/$defs/BaseMember"
      }
    }
  },
  "$defs": {
    "BaseMember": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "toolPackageMemberId": {
          "type": "integer",
          "format": "int32"
        },
        "entityId": {
          "type": "integer",
          "format": "int32"
        },
        "entityType": {
          "$ref": "#/$defs/MemberEntityType"
        }
      }
    },
    "MemberEntityType": {
      "type": "string",
      "description": "",
      "x-enumNames": [
        "Account",
        "AccountContact",
        "StaticList",
        "DynamicList"
      ],
      "enum": [
        "Account",
        "AccountContact",
        "StaticList",
        "DynamicList"
      ]
    },
    "ToolPackageFeature": {
      "type": "string",
      "description": "Zywave tool/content features that can be granted by a tool package. The enum value is the\nstable public identifier exposed by this API; the underlying feature key (Guid) used by the\ninternal contracts is resolved via ToolPackageFeatureMap.",
      "x-enumNames": [
        "AcaReporting",
        "BenefitDocumentBuilder",
        "BreachResponse",
        "CobraNoticesGenerator",
        "ComplianceNoticeBuilder",
        "CompliancePosterBuilder",
        "CustomJobDescriptionBuilder",
        "CyberAssessmentTool",
        "CyberHotline",
        "EmployeeCostCalculator",
        "EmployeeHandbookBuilder",
        "EnrollmentBookletBuilder",
        "FederalPosterAdvisor",
        "FmlaAdvisor",
        "HealthPlanComplianceCalendar",
        "HrHotline",
        "HrSelfAssessmentTool",
        "InPersonInterviewQuestionBuilder",
        "ManagementLiabilityHotline",
        "MultiStateLawsComparisonTool",
        "OshaLog",
        "PerformanceReviewBuilder",
        "PhoneInterviewQuestionBuilder",
        "RelationshipManagementService",
        "SalaryBenchmarking",
        "SampleJobDescriptions",
        "TotalCompensationStatementBuilder",
        "WebAccessibilityTool",
        "ZywaveLearning",
        "ClientContentDisciplineAndTermination",
        "ClientContentEmployeeBenefits",
        "ClientContentHealthCareReform",
        "ClientContentHumanResources",
        "ClientContentRecruitmentAndHiring",
        "ClientContentReferenceCenter",
        "ClientContentSafetyAndWellness",
        "ClientContentStateLaws",
        "ClientContentFormsAndPolicies",
        "ClientContentHrVideos",
        "ClientContentRiskManagement",
        "ClientContentWhatAreYouDoingToday",
        "ClientContentCyber",
        "ClientContentManagementLiability",
        "ClientContentSafety",
        "ClientContentWellness",
        "ClientContentMunicipalAndSchool",
        "ClientContentWebinars",
        "ClientContentNewsletters",
        "ClientContentWhatAreYouDoingTodayBenefits",
        "ClientContentWhatAreYouDoingTodayCyber",
        "ClientContentWhatAreYouDoingTodayDisasterAndEmergency",
        "ClientContentWhatAreYouDoingTodayHr",
        "ContentEmployeeBenefitsEmployeeCommunications",
        "ContentEmployeeBenefitsStateAndFederalCompliance",
        "ContentEmployeeBenefitsWellness",
        "ContentEmployeeBenefitsHumanResources",
        "ContentEmployeeBenefitsEducation",
        "ContentEmployeeBenefitsBrokerInsuranceInsights",
        "ContentEmployeeBenefitsPremiumContent",
        "ContentPcCommercialCoverageEducation",
        "ContentPcEmployeeSafetyCommunications",
        "ContentPcStateAndFederalCompliance",
        "ContentPcPersonalLines",
        "ContentPcRiskManagementAndLossControl",
        "ContentPcHumanResources",
        "ContentPcBrokerInsuranceInsights",
        "ContentPcPremiumContent",
        "CanadaCore",
        "UkCore",
        "BenefitsCore",
        "PcCore",
        "PersonalLinesCore"
      ],
      "x-enum-descriptions": [
        "ACA Reporting",
        "Benefit Document Builder",
        "Breach Response",
        "COBRA Notices Generator",
        "Compliance Notice Builder",
        "Compliance Poster Builder",
        "Custom Job Description Builder",
        "Cyber Assessment Tool",
        "Cyber Hotline",
        "Employee Cost Calculator",
        "Employee Handbook Builder",
        "Enrollment Booklet Builder",
        "Federal Poster Advisor",
        "FMLA Advisor",
        "Health Plan Compliance Calendar",
        "HR Hotline",
        "HR Self-Assessment Tool",
        "In-person Interview Question Builder",
        "Management Liability Hotline",
        "Multi-State Laws Comparison Tool",
        "OSHA Log",
        "Performance Review Builder",
        "Phone Interview Question Builder",
        "Relationship Management Service",
        "Salary Benchmarking",
        "Sample Job Descriptions",
        "Total Compensation Statement Builder",
        "Web Accessibility Tool",
        "Zywave Learning",
        "Client Content: Discipline & Termination",
        "Client Content: Employee Benefits",
        "Client Content: Health Care Reform",
        "Client Content: Human Resources",
        "Client Content: Recruitment & Hiring",
        "Client Content: Reference Center",
        "Client Content: Safety & Wellness",
        "Client Content: State Laws",
        "Client Content: Forms & Policies",
        "Client Content: HR Videos",
        "Client Content: Risk Management",
        "Client Content: What are you doing today?",
        "Client Content: Cyber",
        "Client Content: Management Liability",
        "Client Content: Safety",
        "Client Content: Wellness",
        "Client Content: Municipal & School",
        "Client Content: Webinars",
        "Client Content: Newsletters",
        "Client Content: What are you doing today? - Benefits",
        "Client Content: What are you doing today? - Cyber",
        "Client Content: What are you doing today? - Disaster and Emergency",
        "Client Content: What are you doing today? - HR",
        "Content: Employee Benefits Employee Communications",
        "Content: Employee Benefits State and Federal Compliance",
        "Content: Employee Benefits Wellness",
        "Content: Employee Benefits Human Resources",
        "Content: Employee Benefits Education",
        "Content: Employee Benefits Broker Insurance Insights",
        "Content: Employee Benefits Premium Content",
        "Content: P&C Commercial Coverage Education",
        "Content: P&C Employee Safety Communications",
        "Content: P&C State and Federal Compliance",
        "Content: P&C Personal Lines",
        "Content: P&C Risk Management and Loss Control",
        "Content: P&C Human Resources",
        "Content: P&C Broker Insurance Insights",
        "Content: P&C Premium Content",
        "Canada Core",
        "UK Core",
        "Benefits Core",
        "P&C Core",
        "Personal Lines Core"
      ],
      "enum": [
        "AcaReporting",
        "BenefitDocumentBuilder",
        "BreachResponse",
        "CobraNoticesGenerator",
        "ComplianceNoticeBuilder",
        "CompliancePosterBuilder",
        "CustomJobDescriptionBuilder",
        "CyberAssessmentTool",
        "CyberHotline",
        "EmployeeCostCalculator",
        "EmployeeHandbookBuilder",
        "EnrollmentBookletBuilder",
        "FederalPosterAdvisor",
        "FmlaAdvisor",
        "HealthPlanComplianceCalendar",
        "HrHotline",
        "HrSelfAssessmentTool",
        "InPersonInterviewQuestionBuilder",
        "ManagementLiabilityHotline",
        "MultiStateLawsComparisonTool",
        "OshaLog",
        "PerformanceReviewBuilder",
        "PhoneInterviewQuestionBuilder",
        "RelationshipManagementService",
        "SalaryBenchmarking",
        "SampleJobDescriptions",
        "TotalCompensationStatementBuilder",
        "WebAccessibilityTool",
        "ZywaveLearning",
        "ClientContentDisciplineAndTermination",
        "ClientContentEmployeeBenefits",
        "ClientContentHealthCareReform",
        "ClientContentHumanResources",
        "ClientContentRecruitmentAndHiring",
        "ClientContentReferenceCenter",
        "ClientContentSafetyAndWellness",
        "ClientContentStateLaws",
        "ClientContentFormsAndPolicies",
        "ClientContentHrVideos",
        "ClientContentRiskManagement",
        "ClientContentWhatAreYouDoingToday",
        "ClientContentCyber",
        "ClientContentManagementLiability",
        "ClientContentSafety",
        "ClientContentWellness",
        "ClientContentMunicipalAndSchool",
        "ClientContentWebinars",
        "ClientContentNewsletters",
        "ClientContentWhatAreYouDoingTodayBenefits",
        "ClientContentWhatAreYouDoingTodayCyber",
        "ClientContentWhatAreYouDoingTodayDisasterAndEmergency",
        "ClientContentWhatAreYouDoingTodayHr",
        "ContentEmployeeBenefitsEmployeeCommunications",
        "ContentEmployeeBenefitsStateAndFederalCompliance",
        "ContentEmployeeBenefitsWellness",
        "ContentEmployeeBenefitsHumanResources",
        "ContentEmployeeBenefitsEducation",
        "ContentEmployeeBenefitsBrokerInsuranceInsights",
        "ContentEmployeeBenefitsPremiumContent",
        "ContentPcCommercialCoverageEducation",
        "ContentPcEmployeeSafetyCommunications",
        "ContentPcStateAndFederalCompliance",
        "ContentPcPersonalLines",
        "ContentPcRiskManagementAndLossControl",
        "ContentPcHumanResources",
        "ContentPcBrokerInsuranceInsights",
        "ContentPcPremiumContent",
        "CanadaCore",
        "UkCore",
        "BenefitsCore",
        "PcCore",
        "PersonalLinesCore"
      ]
    }
  }
}