Insert new package into the system

{
  "type": "object",
  "description": "The PackageDTO Class.\nContains relevant fields of Package DTO by masking actual Package entity's fields in application.\n            ",
  "required": [
    "packageName",
    "packageType",
    "registrationFee",
    "serviceFee"
  ],
  "properties": {
    "addOns": {
      "type": "array",
      "description": "Extra articles list added to the given package.\n            ",
      "items": {
        "type": "object",
        "description": "The PackageItemDTO Class.\nContains relevant fields of PackageItem DTO by masking actual Package entity's fields in application.\n            ",
        "required": [
          "articleId"
        ],
        "properties": {
          "articleId": {
            "type": "integer",
            "format": "int32",
            "description": "Refer to ArticleId in Article table in DB.\n            "
          },
          "articleName": {
            "type": "string",
            "description": "Name of the article(Addon) in a particular package.\n             read only\n            "
          },
          "articleNumber": {
            "type": "integer",
            "format": "int32",
            "description": "Number assigned the article(Addon) in a particular package.\n             read only\n            "
          },
          "articlePrice": {
            "type": "number",
            "format": "decimal",
            "description": "Price of the article determined from that package.\nPrice of a same article can be varied from package to package.\n            "
          },
          "endOrder": {
            "type": "integer",
            "format": "int32",
            "description": "Number of the installment this article is available to.\n            "
          },
          "isIncludeServiceInCharge": {
            "type": "boolean",
            "description": "Is Included in service charge "
          },
          "measureUnit": {
            "type": "string"
          },
          "numberOfItems": {
            "type": "number",
            "format": "decimal",
            "description": "How many article(Addon) is available for that package from that type.\n            "
          },
          "startOrder": {
            "type": "integer",
            "format": "int32",
            "description": "Number of the installment this article is available from.\n            "
          }
        },
        "additionalProperties": false
      }
    },
    "addonFee": {
      "type": "number",
      "format": "decimal",
      "description": "sum of addon fees.\nincoming values for this filed will ignore.\n            "
    },
    "applyForAllGyms": {
      "type": "boolean",
      "description": "Boolean value to indicate wheather package is available in all the gyms.\n            "
    },
    "availableGyms": {
      "type": "array",
      "description": "Gyms list where this package is available.\n            ",
      "items": {
        "type": "object",
        "description": "The GymDTO Class.\nContains relevant fields of Gym DTO by masking actual Gym entity's fields in application.\n            ",
        "properties": {
          "externalGymNumber": {
            "type": "integer",
            "format": "int32"
          },
          "gymId": {
            "type": "integer",
            "format": "int32"
          },
          "gymName": {
            "type": "string"
          },
          "location": {
            "type": "string"
          }
        },
        "additionalProperties": false
      }
    },
    "bindingPeriod": {
      "type": "integer",
      "format": "int32",
      "description": "Range of period a member is bound to the contract if he/she choose this package.\n            "
    },
    "createdDate": {
      "type": "string",
      "format": "date-time",
      "description": "Package created DateTime.\n            "
    },
    "createdUser": {
      "type": "string",
      "description": "Package created user.\n            "
    },
    "description": {
      "type": "string",
      "description": "Common descriptions about package.If there are more instructions \n             can be stored as comma separated values.\n            "
    },
    "endDate": {
      "type": "string",
      "format": "date-time",
      "description": "End date of the package.After that package is not valid for use.\n            "
    },
    "expireInMonths": {
      "type": "integer",
      "format": "int32",
      "description": "No of months the fixed package is valid for sale\n            "
    },
    "features": {
      "type": "string",
      "description": "What are the facilities, features available for package.ex:- wifi,\nACm etc.Can be stored as comma seperated values.\n            "
    },
    "freeMonths": {
      "type": "integer",
      "format": "int32",
      "description": "No of months gym member can come without payments.\n            "
    },
    "instructionsToGymUsers": {
      "type": "string",
      "description": "Instruction to the gym members relevant to the package.\n             If there are more instructions can be stored as comma seperated values.\n            "
    },
    "instructionsToWebUsers": {
      "type": "string",
      "description": "Instruction to the MRM members relevant to the package.\n             If there are more instructions can be stored as comma seperated values.\n            "
    },
    "isActive": {
      "type": "boolean",
      "description": "Boolean value to indicate this package is still active or not.\n            "
    },
    "isAtg": {
      "type": "boolean",
      "description": "Boolean value to indicate ATG transaction from bank is applicable or not.\n            "
    },
    "isAutoRenew": {
      "type": "boolean",
      "description": "Boolean value to indicate the contract will auto renew after expiration \n             if this package would be chosen.\n            "
    },
    "isFirstMonthFree": {
      "type": "boolean",
      "description": "Boolean value to indicate if the first month charges is free.\n            "
    },
    "isRegistrationFee": {
      "type": "boolean",
      "description": "Boolean value to indicate this package has registration fee or not.\n            "
    },
    "isRestAmount": {
      "type": "boolean",
      "description": "Boolean value to indicate rest amount is applicable or not.\n            "
    },
    "isShownInMobile": {
      "type": "boolean",
      "description": "Boolean value to indicate package is visible in Mobile App or not.\n            "
    },
    "isSponsorPackage": {
      "type": "boolean",
      "description": "Boolean value to indicate package can be sponsored or not by other party.\n            "
    },
    "maximumGiveAwayRestAmount": {
      "type": "number",
      "format": "decimal",
      "description": "If a member join the gym middle of a month via this package, \n             what is the maximum amount of price can be neglected from payment from the member.\n            "
    },
    "memberCanAddAddOns": {
      "type": "boolean",
      "description": "Boolean value to indicate member can add extra addons he wish if he choose this package.\n            "
    },
    "memberCanLeaveWithinFreePeriod": {
      "type": "boolean",
      "description": "Boolean value to indicate if member can leave from contract within \n             free period if he/she choose this package.\n            "
    },
    "memberCanRemoveAddOns": {
      "type": "boolean",
      "description": "Boolean value to indicate member can remove already added addons if he choose this package.\n            "
    },
    "modifiedDate": {
      "type": "string",
      "format": "date-time",
      "description": "Package last modified DateTime.\n            "
    },
    "modifiedUser": {
      "type": "string",
      "description": "Package last modified user.\n            "
    },
    "monthlyFee": {
      "type": "number",
      "format": "decimal",
      "description": "Monthly installment fee if package is not fixed visit.\naddition of the servicefee and addon fees divided by binding period.\n             read only\n            "
    },
    "nextPackageNumber": {
      "type": "integer",
      "format": "int32",
      "description": "Next Package the contract continue after the binding period of this package.\n            "
    },
    "numberOfInstallments": {
      "type": "integer",
      "format": "int32",
      "description": "Maximum Number of installment a member can divide the package price/cost to pay.\n            "
    },
    "numberOfVisits": {
      "type": "integer",
      "format": "int32",
      "description": "If package is fixed visit type, then how many visits are available for this package.\n            "
    },
    "packageId": {
      "type": "integer",
      "format": "int32"
    },
    "packageName": {
      "type": "string"
    },
    "packageNumber": {
      "type": "string"
    },
    "packageType": {
      "type": "string",
      "description": "Package type can be either fixed visit or unlimited.\n            "
    },
    "perVisitPrice": {
      "type": "number",
      "format": "decimal",
      "description": "Cost/Price of the single visit to gym.\n            "
    },
    "registrationFee": {
      "type": "number",
      "format": "decimal",
      "description": "Registartion fee for the package at a gym.\n             read only\n            "
    },
    "serviceFee": {
      "type": "number",
      "format": "decimal",
      "description": "total Service charge of the package for entire period.\n            "
    },
    "shownInWeb": {
      "type": "boolean",
      "description": "Boolean value to show this package in MRM system or not.\n            "
    },
    "startDate": {
      "type": "string",
      "format": "date-time",
      "description": "Start date of the package.\n            "
    },
    "tags": {
      "type": "string",
      "description": "Comma separated string values in case of need of maintain some labels kind of \n             stuff relevant to the package.\n            "
    },
    "totalPrice": {
      "type": "number",
      "format": "decimal",
      "description": "total price for the package including Addon fees, service fee and registration fee.\nincoming values for this field will ignore.\n            "
    }
  },
  "additionalProperties": false
}