action britbox_get_account {
  label: "getAccount"
  description: "Get the details of an account along with the profiles and entitlements under it."
  provider: britbox
  method: GET
  path: "/account"
  encoding: json
  output: {
    type: "object"
    required: ["email", "id", "marketingEnabled", "pinEnabled", "primaryProfileId", "profiles", "subscriptionCode", "trackingEnabled"]
    properties: {
      address: {
        type: "object"
        properties: {
          addressLine1: {
            type: "string"
            description: "The first line of the street address."
          }
          addressLine2: {
            type: "string"
            description: "The second line of the street address."
          }
          city: {
            type: "string"
            description: "The city name."
          }
          country: {
            type: "string"
            description: "The country name or code."
          }
          postcode: {
            type: "string"
            description: "The postal or zip code."
          }
          state: {
            type: "string"
            description: "The state name or abbreviation."
          }
        }
        additionalProperties: false
      }
      defaultPaymentInstrumentId: {
        type: "string"
        description: "The id of the payment instrument to use by default for account transactions.\n\n **DEPRECATED** The property `defaultPaymentMethodId` is now preferred.\n"
      }
      defaultPaymentMethodId: {
        type: "string"
        description: "The id of the payment method to use by default for account transactions."
      }
      emailVerified: {
        type: "boolean"
        description: "Whether the email address has been verified.\n\nUsers who receive an emailed verification url click the link to verify their email address.\n"
      }
      entitlements: {
        type: "array"
        description: "The list of entitlements to playback specific items."
        items: {
          type: "object"
        }
      }
      firstName: {
        type: "string"
        description: "The first name of the account holder."
      }
      id: {
        type: "string"
        description: "The id of the account."
      }
      isFirstTimeSubscriber: {
        type: "boolean"
        description: "Whether the account has the very first subscription."
      }
      lastName: {
        type: "string"
        description: "The last name of the account holder."
      }
      marketingEnabled: {
        type: "boolean"
        description: "Whether the account has opted in or out of marketing material."
      }
      minRatingPlaybackGuard: {
        type: "string"
        description: "The classification rating defining the minimum rating level a user should be\nforced to enter the account pin code for playback. Anything at this rating\nlevel or above will require the pin for playback.\n\ne.g. AUOFLC-MA15+\n\nIf you want to disable this guard pass an empty string or `null`.\n"
      }
      pinEnabled: {
        type: "boolean"
        description: "When an account level pin is defined this will be true."
      }
      primaryProfileId: {
        type: "string"
        description: "The id of the primary profile."
      }
      profiles: {
        type: "array"
        description: "The list of profiles under this account."
        items: {
          type: "object"
          required: ["id", "name", "isActive", "pinEnabled", "purchaseEnabled", "marketingEnabled", "segments"]
          properties: {
            color: {
              type: "string"
              description: "Hex color value assigned to the profile."
            }
            heroAutoplay: {
              type: "boolean"
              description: "Gets the Hero row clip auto playback enabled"
            }
            heroWithAudio: {
              type: "boolean"
              description: "Gets the Hero row clip auto playback audio enabled"
            }
            id: {
              type: "string"
              description: "The id of the profile."
            }
            isActive: {
              type: "boolean"
              description: "Whether the profile is active or not.\n\n**DEPRECATED** - Always true. Inactive profiles are no longer returned.\n"
            }
            languageCode: {
              type: "string"
              description: "The code of the preferred language for the profile.\nMust be a valid ISO language code e.g. \"en-US\" and must match the code of\none of the languages specified in the app config.\nSee https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes\n"
            }
            marketingEnabled: {
              type: "boolean"
              description: "Whether the profile has opted in or out of marketing material.\n\n**DEPRECATED** - Marketing material is no longer tied to profiles, only account. See `Account.marketingEnabled`.\n"
            }
            maxRatingContentFilter: {
              type: "object"
              required: ["code", "name"]
              properties: {
                code: {
                  type: "string"
                  description: "The unique code for a classification."
                }
                name: {
                  type: "string"
                  description: "The name of the classification for display."
                }
              }
            }
            minRatingPlaybackGuard: {
              type: "object"
              additionalProperties: true
            }
            name: {
              type: "string"
              description: "The unique name of the profile."
            }
            pinEnabled: {
              type: "boolean"
              description: "Whether a pin is required to enter the profile."
            }
            purchaseEnabled: {
              type: "boolean"
              description: "Whether the profile can make purchases with the account payment options."
            }
            segments: {
              type: "array"
              description: "The segments a profile has been placed under"
              items: {
                type: "string"
              }
            }
          }
        }
      }
      segments: {
        type: "array"
        description: "The segments an account has been placed under"
        items: {
          type: "string"
        }
      }
      subscriptionCode: {
        type: "string"
        description: "The active subscription code for an account.\n\nThe value of this should be passed to any endpoints accepting a `sub` query parameter.\n"
      }
      subscriptions: {
        type: "array"
        description: "The list of subscriptions, if any, the account has signed up to."
        items: {
          type: "object"
          required: ["code", "startDate", "isTrialPeriod", "planId", "status"]
          properties: {
            code: {
              type: "string"
              description: "The unique subscription code."
            }
            endDate: {
              type: "string"
              format: "date-time"
              description: "The end date of a subscription.\n\nAfter this date the subscription will become expired. If this is a recurring\nsubscription which has not been cancelled then the account holder will be\nautomatically charged and a new subscription will be activated.\n\nSome subscriptions may not have an end date, in which case this\nproperty will not exist.\n"
            }
            id: {
              type: "string"
              description: "Unique identifier for the subscription."
            }
            isTrialPeriod: {
              type: "boolean"
              description: "True if a subscription is in its trial period, false if not."
            }
            planId: {
              type: "string"
              description: "The plan a subscription belongs to."
            }
            startDate: {
              type: "string"
              format: "date-time"
              description: "The start date of a subscription."
            }
            status: {
              type: "string"
              description: "The status of a subscription."
              enum: ["Active", "Cancelled", "Lapsed", "Expired", "None"]
            }
          }
          additionalProperties: false
        }
      }
      trackingEnabled: {
        type: "boolean"
        description: "Whether usage tracking is associated with the account or anonymous."
      }
      usedFreeTrial: {
        type: "boolean"
        description: "Whether the account has used up their free trial period of a plan."
      }
    }
  }
}