EnterpriseQuery

All enterprise query roots, merged. EnterpriseCoreQuery carries the core management resolvers; the rest are per-domain modules.

Fields

    billingInfo
    BillingInfo!
    Required
    Current billing info (plan, cycle, subscription status) for an enterprise.
    dashboardStats
    DashboardStats!
    Required
    High-level dashboard stats (voucher counts, savings) for an enterprise.
    enterprise
    Enterprise!
    Required
    The enterprise this token acts for. Always present: a token names exactly one enterprise.
    invoices
    BillingInvoiceConnection!
    Required
    List an enterprise's invoices, newest first.
      after
      String

      Opaque cursor — pass back the previous page's endCursor.

      before
      String

      Opaque cursor — pass back the previous page's startCursor.

      first
      Int
      How many items to return, paging forward.
      last
      Int
      How many items to return, paging backwards.
    settings
    [SettingsRecord!]!
    Required
    List an enterprise's settings (there is typically one record per enterprise, created on first read).
    usageSummary
    BillingUsageSummary!
    Required
    Usage summary (users, vouchers, API calls, storage) for a billing period.
      periodEnd
      DateTime!
      Required
      Last moment of the billing window (RFC 3339).
      periodStart
      DateTime!
      Required
      First moment of the billing window (RFC 3339).
    user
    Member!
    Required
    Fetch one member of this enterprise, by platform user id.
      userId
      Int!
      Required
      Unique identifier of the user.
    users
    MemberConnection!
    Required
    List an enterprise's users.
      after
      String

      Opaque cursor — pass back the previous page's endCursor.

      before
      String

      Opaque cursor — pass back the previous page's startCursor.

      first
      Int
      How many items to return, paging forward.
      isActive
      Boolean
      Restrict to active or suspended users. Omit for both.
      last
      Int
      How many items to return, paging backwards.
    voucher
    Voucher!
    Required
    One of the enterprise's vouchers. A voucher belonging to another enterprise is not found.
      voucherId
      Int!
      Required
      Unique identifier of the voucher.
    voucherAnalytics
    VoucherAnalytics!
    Required
    Voucher analytics (usage summary, per-voucher performance) for an enterprise, optionally scoped to a date range.
      endDate
      DateTime
      End of the reporting window (RFC 3339). Omit for all time.
      startDate
      DateTime
      Start of the reporting window (RFC 3339). Omit for all time.
    voucherTemplate
    VoucherTemplate
    Fetch one enterprise voucher template.
      templateId
      Int!
      Required
      Unique identifier of the template.
    voucherTemplates
    VoucherTemplateConnection!
    Required
    List an enterprise's voucher templates.
      after
      String

      Opaque cursor — pass back the previous page's endCursor.

      before
      String

      Opaque cursor — pass back the previous page's startCursor.

      first
      Int
      How many items to return, paging forward.
      isActive
      Boolean
      Restrict to active or inactive templates. Omit for both.
      last
      Int
      How many items to return, paging backwards.
      voucherType
      String
      Filter by voucher type. Omit for all.
    voucherUsageStats
    VoucherUsageStats!
    Required
    Aggregate usage statistics for one enterprise voucher.
      voucherId
      Int!
      Required
      Voucher to report redemptions for.
    vouchers
    VoucherConnection!
    Required
    List an enterprise's vouchers.
      after
      String

      Opaque cursor — pass back the previous page's endCursor.

      before
      String

      Opaque cursor — pass back the previous page's startCursor.

      first
      Int
      How many items to return, paging forward.
      isActive
      Boolean
      Restrict to active or inactive vouchers. Omit for both.
      last
      Int
      How many items to return, paging backwards.
      search
      String
      Match on voucher code or name. Omit for all.
Built with