OBJECT

User

A user that can login to Sonar.

link GraphQL Schema definition

  • type User implements EmailableInterface, InventoryitemableInterface, GenericinventoryitemableInterface, SmsableInterface, LoggableInterface, AccessloggableInterface {
  • # The ID of the entity.
  • id: Int64Bit!
  • # An ID that uniquely identifies this entity across the whole Sonar system.
  • sonar_unique_id: ID!
  • # The date and time this entity was created.
  • created_at: Datetime!
  • # The last date and time this entity was modified.
  • updated_at: Datetime!
  • # A string that shows the version of this entity. It will be incremented whenever
  • # the entity is modified.
  • _version: String!
  • # Whether or not the user has completed the setup process.
  • completed_setup: Boolean!
  • # An email address.
  • email_address: EmailAddress!
  • # Whether or not this is enabled.
  • enabled: Boolean!
  • # Whether or not this user is a Sonar employee.
  • is_sonar_staff: Boolean
  • # A supported language.
  • language: Language
  • # A mobile phone number. This will be used to send SMS messages.
  • mobile_number: Numeric
  • # A descriptive name.
  • name: String!
  • # The publicly viewable name of this user.
  • public_name: String!
  • # The ID of a Role.
  • role_id: Int64Bit
  • # Super admins receive all system permissions automatically, regardless of their
  • # role.
  • super_admin: Boolean!
  • # A username, used for authentication.
  • username: String!
  • # A role defines the permission set that a user has.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # applied_permissions: A list of permissions associated with this
  • # role.
  • # name: A descriptive name.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • role(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • applied_permissions: [Permission],
  • name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): Role
  • # An email.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # body: The body.
  • # email_address: An email address.
  • # emailable_id: The ID of the entity that this email was sent to.
  • # emailable_type: The type of entity that this email was sent to.
  • # reject_reason: If rejected, the reason for rejection.
  • # status: The status.
  • # subject: The subject.
  • # to_name: The name of the recipient.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • emails(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • body: Text,
  • email_address: EmailAddress,
  • emailable_id: Int64Bit,
  • emailable_type: EmailableType,
  • reject_reason: String,
  • status: EmailStatus,
  • subject: String,
  • to_name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): EmailConnection!
  • # An inventory item.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # claimed_user_id: The ID of the `User` that claimed this.
  • # deployment_type_id: The ID of a `DeploymentType`.
  • # flapping: Whether this inventory item is flapping or not.
  • # icmp_device_status: The current ICMP monitoring status of an
  • # `InventoryItem`.
  • # icmp_status_flap_count: The number of times the ICMP status has
  • # flapped.
  • # icmp_status_last_change: The timestamp of when the ICMP status
  • # last changed.
  • # icmp_threshold_violation: The ICMP monitoring threshold
  • # violation type.
  • # inventory_model_id: The ID of an `InventoryModel`.
  • # inventoryitemable_id: The ID of the entity that this inventory
  • # item is assigned to.
  • # inventoryitemable_type: The type of entity that this inventory
  • # item is assigned to.
  • # latitude: A decimal latitude.
  • # longitude: A decimal longitude.
  • # metadata: The metadata.
  • # overall_status: The overall status of an `InventoryItem` (the
  • # worse of ICMP/SNMP status).
  • # parent_inventory_item_id: The ID of the parent `InventoryItem`.
  • # preseem_status: The status of the device, as read from Preseem.
  • # purchase_order_item_id: The ID of a purchase order item
  • # purchase_price: The purchase price of this item.
  • # snmp_device_status: The current SNMP monitoring status of an
  • # `InventoryItem`.
  • # snmp_status_flap_count: The number of times the SNMP status has
  • # flapped.
  • # snmp_status_last_change: The timestamp of when the SNMP status
  • # last changed.
  • # snmp_status_message: The SNMP monitoring status message.
  • # status: The physical status of this item.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • inventory_items(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • claimed_user_id: Int64Bit,
  • deployment_type_id: Int64Bit,
  • flapping: Boolean,
  • icmp_device_status: InventoryItemDeviceStatus,
  • icmp_status_flap_count: Int,
  • icmp_status_last_change: Datetime,
  • icmp_threshold_violation: InventoryItemIcmpThresholdViolation,
  • inventory_model_id: Int64Bit,
  • inventoryitemable_id: Int64Bit,
  • inventoryitemable_type: InventoryitemableType,
  • latitude: Latitude,
  • longitude: Longitude,
  • metadata: String,
  • overall_status: InventoryItemDeviceStatus,
  • parent_inventory_item_id: Int64Bit,
  • preseem_status: PreseemStatus,
  • purchase_order_item_id: Int64Bit,
  • purchase_price: Int,
  • snmp_device_status: InventoryItemDeviceStatus,
  • snmp_status_flap_count: Int,
  • snmp_status_last_change: Datetime,
  • snmp_status_message: String,
  • status: InventoryItemStatus,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): InventoryItemConnection!
  • # A generic inventory item.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # genericinventoryitemable_id: The type of entity that owns this
  • # generic `InventoryItem`.
  • # genericinventoryitemable_type: The ID of the entity that owns
  • # this generic `InventoryItem`.
  • # inventory_model_id: The ID of an `InventoryModel`.
  • # quantity: The quantity for this service.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • generic_inventory_items(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • genericinventoryitemable_id: Int64Bit,
  • genericinventoryitemable_type: InventoryitemableType,
  • inventory_model_id: Int64Bit,
  • quantity: Int,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): GenericInventoryItemConnection!
  • # An SMS outbound message.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # category: The category of the message.
  • # cost_in_hundredths: The cost associated with the SMS message.
  • # Stored as one hundredth of the smallest currency value (e.g. cents, pence,
  • # pesos.)
  • # destination_country: The country code of the destination mobile
  • # phone number.
  • # error_message: The error message.
  • # last_status_check: The provider message ID.
  • # message_text: The message text.
  • # mobile_number: The destination mobile phone number.
  • # provider_message_id: The provider message ID.
  • # segments: The number of segments needed to deliver message
  • # text.
  • # smsable_id: The ID of the entity that this SMS was sent to.
  • # smsable_type: The type of entity that this SMS was sent to.
  • # status: The current status of the message.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • sms_outbound_messages(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • category: SmsOutboundCategory,
  • cost_in_hundredths: Int,
  • destination_country: String,
  • error_message: String,
  • last_status_check: Datetime,
  • message_text: String,
  • mobile_number: String,
  • provider_message_id: String,
  • segments: Int,
  • smsable_id: Int64Bit,
  • smsable_type: SmsableType,
  • status: SmsOutboundStatus,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): SmsOutboundMessageConnection!
  • # A log entry.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # current: Current data.
  • # legacy: Whether or not this log was transferred from a Sonar v1
  • # instance. If so, the formatting will not match current version logs.
  • # legacy_title: A title which is only populated on logs that were
  • # imported from Sonar v1.
  • # level: The severity level.
  • # loggable_id: The ID of the entity that this log is attached to.
  • # loggable_type: The type of entity that this log is attached to.
  • # logged_entity_id: The entity ID that triggered the log.
  • # logged_entity_type: The entity that triggered the log.
  • # message: The message.
  • # previous: Previous data.
  • # relation_data: Data from objects related to this change.
  • # type: The type.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • logs(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • current: Text,
  • legacy: Boolean,
  • legacy_title: String,
  • level: LogLevel,
  • loggable_id: Int64Bit,
  • loggable_type: String,
  • logged_entity_id: Int64Bit,
  • logged_entity_type: String,
  • message: Text,
  • previous: Text,
  • relation_data: Text,
  • type: LogType,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): LogConnection!
  • # An access log history on an entity.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # access_datetime: The date and time that this entity was
  • # accessed.
  • # accessloggable_id: The ID of the entity that this access log
  • # belongs to.
  • # accessloggable_type: The entity that this access log belongs
  • # to.
  • # entity_id: The ID of the entity that this access log belongs
  • # to.
  • # entity_name: The entity that this access log belongs to.
  • # user_id: The ID of the user that accessed this entity.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • access_logs(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • access_datetime: Datetime,
  • accessloggable_id: Int64Bit,
  • accessloggable_type: String,
  • entity_id: Int64Bit,
  • entity_name: String,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccessLogConnection!
  • # An iCalendar calendar.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # enabled: Whether or not this is enabled.
  • # name: A descriptive name.
  • # url: The url that can be used on remote calendars for
  • # integration of Sonar events.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • calendar_icals(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • enabled: Boolean,
  • name: String,
  • url: URL,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CalendarIcalConnection!
  • # A debit.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # account_id: The ID of an Account.
  • # amount: The amount, in the smallest currency value (e.g. cents,
  • # pence, pesos.)
  • # company_id: The ID of the company that this entity operates
  • # under.
  • # description: A human readable description.
  • # general_ledger_code: A general ledger code.
  • # general_ledger_code_description: A general ledger code
  • # description.
  • # invoice_id: The ID of an `Invoice`.
  • # linked_debit_id: The ID of the Debit which is linked to the
  • # current Debit.
  • # minutes: The total number of minutes.
  • # number_of_months: The number of months of service this invoice
  • # was billed for.
  • # prorated_from: The date this transaction was prorated from.
  • # prorated_to: The date this transaction was prorated to.
  • # quantity: The quantity for this service.
  • # quantity_prorated_from: The quantity the associated service had
  • # before the quantity was changed and prorated.
  • # quantity_prorated_to: The quantity the associated service was
  • # changed to when the quantity was changed and prorated.
  • # reversed: Whether or not this has been reversed.
  • # reversed_at: When this was reversed.
  • # reversed_by_user_id: The user ID that reversed this.
  • # service_id: The ID of a Service.
  • # service_name: The name of a service.
  • # service_transaction_type: The type of transaction on this
  • # service.
  • # type: The type.
  • # user_id: The ID of the user who created this transaction.
  • # voice_service_generic_parameter_id: The ID of a voice service
  • # configuration parameter.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • debits(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • amount: Int,
  • company_id: Int64Bit,
  • description: String,
  • general_ledger_code: String,
  • general_ledger_code_description: String,
  • invoice_id: Int64Bit,
  • linked_debit_id: Int64Bit,
  • minutes: Float,
  • number_of_months: Int,
  • prorated_from: Date,
  • prorated_to: Date,
  • quantity: Int,
  • quantity_prorated_from: Int,
  • quantity_prorated_to: Int,
  • reversed: Boolean,
  • reversed_at: Datetime,
  • reversed_by_user_id: Int64Bit,
  • service_id: Int64Bit,
  • service_name: String,
  • service_transaction_type: ServiceTransactionType,
  • type: ServiceType,
  • user_id: Int64Bit,
  • voice_service_generic_parameter_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DebitConnection!
  • # A discount.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # account_id: The ID of an Account.
  • # amount: The amount of the `Discount`.
  • # amount_remaining: The amount remaining that can be used.
  • # company_id: The ID of the company that this entity operates
  • # under.
  • # debit_id: If this discount was created due to reversal of a
  • # `Debit`, this field will link to the reversed `Debit`.
  • # description: A human readable description.
  • # general_ledger_code: A general ledger code.
  • # general_ledger_code_description: A general ledger code
  • # description.
  • # minutes: The total number of minutes.
  • # prorated_from: The date this transaction was prorated from.
  • # prorated_to: The date this transaction was prorated to.
  • # quantity: The quantity for this service.
  • # quantity_prorated_from: The quantity the associated service had
  • # before the quantity was changed and prorated.
  • # quantity_prorated_to: The quantity the associated service was
  • # changed to when the quantity was changed and prorated.
  • # reversed: Whether or not this has been reversed.
  • # reversed_at: When this was reversed.
  • # reversed_by_user_id: The user ID that reversed this.
  • # service_id: The ID of a Service.
  • # service_name: The name of a service.
  • # service_transaction_type: The type of transaction on this
  • # service.
  • # tax_committed: Whether this entity's taxes have been committed
  • # or not.
  • # tax_provider_id: The ID of an `TaxProvider`.
  • # type: The type.
  • # user_id: The ID of the user who created this transaction.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • discounts(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • amount: Int,
  • amount_remaining: Int,
  • company_id: Int64Bit,
  • debit_id: Int64Bit,
  • description: String,
  • general_ledger_code: String,
  • general_ledger_code_description: String,
  • minutes: Float,
  • prorated_from: Date,
  • prorated_to: Date,
  • quantity: Int,
  • quantity_prorated_from: Int,
  • quantity_prorated_to: Int,
  • reversed: Boolean,
  • reversed_at: Datetime,
  • reversed_by_user_id: Int64Bit,
  • service_id: Int64Bit,
  • service_name: String,
  • service_transaction_type: ServiceTransactionType,
  • tax_committed: Boolean,
  • tax_provider_id: Int64Bit,
  • type: ServiceType,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DiscountConnection!
  • # A task.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # completable_id: The ID of the entity that completes or
  • # completed this task.
  • # completable_type: The type of entity that completes this task.
  • # complete: Whether or not this is complete.
  • # completed_at: The date and time this was completed.
  • # completed_by_user_id: The `User` that completed this.
  • # completion_type: How this task gets marked as completed.
  • # due: The date on which the task is due.
  • # list_order: The order this item is shown in a list.
  • # task: The task to be performed.
  • # taskable_id: The ID of the entity that the task is associated
  • # with.
  • # taskable_type: The entity that the task is associated with.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • tasks(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • completable_id: Int64Bit,
  • completable_type: CompletableType,
  • complete: Boolean,
  • completed_at: Datetime,
  • completed_by_user_id: Int64Bit,
  • completion_type: TaskCompletionType,
  • due: Date,
  • list_order: Int,
  • task: Text,
  • taskable_id: Int64Bit,
  • taskable_type: TaskableType,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): TaskConnection!
  • # A note.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # message: The message.
  • # noteable_id: The ID of the entity that owns this note.
  • # noteable_type: The type of entity that owns this note.
  • # priority: The priority of this item.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • notes(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • message: Text,
  • noteable_id: Int64Bit,
  • noteable_type: NoteableType,
  • priority: NotePriority,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): NoteConnection!
  • # A record a `Payment` reversal.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # amount: The amount, in the smallest currency value (e.g. cents,
  • # pence, pesos.)
  • # description: A human readable description.
  • # payment_id: The ID of a `Payment`.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • reversed_payments(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • amount: Int,
  • description: String,
  • payment_id: Int64Bit,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ReversedPaymentConnection!
  • # A record of a refund applied to a `Payment`.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # amount: The amount, in the smallest currency value (e.g. cents,
  • # pence, pesos.)
  • # description: A human readable description.
  • # payment_id: The ID of a `Payment`.
  • # payment_tracker_id: The unique tracking ID for this payment.
  • # processor_response_message: The response from the payment
  • # processor when this payment was submitted.
  • # transaction_id: The transaction ID from the credit card
  • # provider.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • refunded_payments(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • amount: Int,
  • description: String,
  • payment_id: Int64Bit,
  • payment_tracker_id: String,
  • processor_response_message: String,
  • transaction_id: String,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): RefundedPaymentConnection!
  • # A ticket.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # global_updated_at: The last date and time this entity was
  • # updated, or was the subject of a log.
  • # closed_at: The time this was closed at.
  • # closed_by_user_id: The ID of the `User` that closed this.
  • # description: A human readable description.
  • # due_date: The date this invoice is due by.
  • # inbound_mailbox_id: The ID of an `InboundMailbox`.
  • # parent_ticket_id: The ID of the `Ticket` that this `Ticket` is
  • # a child of.
  • # priority: The priority of this item.
  • # spam_score: Mail processor's spam rating for whether or not
  • # this is spam.
  • # status: The status.
  • # subject: The subject.
  • # ticket_group_id: The ID of a `TicketGroup`.
  • # ticketable_id: The ID of the entity that this `Ticket` is
  • # associated with.
  • # ticketable_type: The type of entity that this `Ticket` is
  • # associated with.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • tickets(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • global_updated_at: Datetime,
  • closed_at: Datetime,
  • closed_by_user_id: Int64Bit,
  • description: Text,
  • due_date: Date,
  • inbound_mailbox_id: Int64Bit,
  • parent_ticket_id: Int64Bit,
  • priority: TicketPriority,
  • spam_score: Float,
  • status: TicketStatus,
  • subject: String,
  • ticket_group_id: Int64Bit,
  • ticketable_id: Int64Bit,
  • ticketable_type: TicketableType,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): TicketConnection!
  • # A reply on a `Ticket`.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # author: The author.
  • # author_email: The email address of the author.
  • # body: The body.
  • # headers: The email headers.
  • # incoming: Whether or not the reply was incoming (from an
  • # external party) or outgoing (from a Sonar `User`.)
  • # raw_body: The raw body, before any Sonar parsing.
  • # signature: The signature to append. You can include
  • # `[PUBLIC_NAME]` as a variable to insert the user's public name when the
  • # signature is appended.
  • # ticket_id: The ID of a `Ticket`.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • ticket_replies(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • author: String,
  • author_email: EmailAddress,
  • body: Text,
  • headers: Text,
  • incoming: Boolean,
  • raw_body: Text,
  • signature: Text,
  • ticket_id: Int64Bit,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): TicketReplyConnection!
  • # A comment on a `Ticket`.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # body: The body.
  • # ticket_id: The ID of a `Ticket`.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • ticket_comments(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • body: Text,
  • ticket_id: Int64Bit,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): TicketCommentConnection!
  • # A subscription to notifications for an entity.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # is_suspended: When suspended, the subscription will not send
  • # notifications. Permission changes and other actions may cause a subscription to
  • # become suspended.
  • # subscribable_id: The id of the entity that is being subscribed
  • # to.
  • # subscribable_type: The type of entity that is being subscribed
  • # to.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • subscriptions(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • is_suspended: Boolean,
  • subscribable_id: Int64Bit,
  • subscribable_type: SubscribableType,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): SubscriptionConnection!
  • # An override to a particular day and time a `ScheduleBlocker` would otherwise
  • # cover.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # schedule_blocker_id: The ID of a `ScheduleBlocker`.
  • # start_datetime: The date and time that this starts.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • schedule_blocker_overrides(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • schedule_blocker_id: Int64Bit,
  • start_datetime: Datetime,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ScheduleBlockerOverrideConnection!
  • # The record of a check in to a `Job`.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # check_in_datetime: The date and time that this `Job` was
  • # checked into.
  • # check_out_datetime: The date and time that this `Job` was
  • # checked out of.
  • # checked_in_by_user_id: The ID of the `User` that created this
  • # check in.
  • # checked_out_by_user_id: The ID of the `User` that updated this
  • # check in with a check out date and time.
  • # job_id: The ID of a `Job`.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • job_check_ins(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • check_in_datetime: Datetime,
  • check_out_datetime: Datetime,
  • checked_in_by_user_id: Int64Bit,
  • checked_out_by_user_id: Int64Bit,
  • job_id: Int64Bit,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): JobCheckInConnection!
  • # A single PDF containing multiple invoices for printing.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # date: A date
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • printed_invoice_batches(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • date: Date,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): PrintedInvoiceBatchConnection!
  • # A `Notification`.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # is_read: Whether this notification is read or unread.
  • # notifiable_id: The ID of the entity that the notification is
  • # related to.
  • # notifiable_type: The type of entity that the notification is
  • # related to.
  • # type: The type.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • notifications(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • is_read: Boolean,
  • notifiable_id: Int64Bit,
  • notifiable_type: NotifiableType,
  • type: NotificationType,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): NotificationConnection!
  • # A user-defined search filter that applies to a specific type of entity.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # all_users: Whether the filter is available to every user
  • # (admins only).
  • # entity_type: The type of entity this filter belongs to.
  • # filter: The actual filter, as JSON.
  • # name: The filter's name.
  • # user_id: The ID of the user that created this entity.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • search_filters(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • all_users: Boolean,
  • entity_type: String,
  • filter: Text,
  • name: String,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): SearchFilterConnection!
  • # The relationship between an order group and a user.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # is_approver: Whether a user is authorized to approve purchase
  • # orders created in this order group.
  • # order_group_id: The ID of an order group.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • order_group_users(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • is_approver: Boolean,
  • order_group_id: Int64Bit,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): OrderGroupUserConnection!
  • # A `StoredView` associated with a `User`.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # location: The location in the UI that this view is available.
  • # stored_view_id: The ID of a `StoredView` entity.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • stored_view_users(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • location: String,
  • stored_view_id: Int64Bit,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): StoredViewUserConnection!
  • # A vehicle.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # geopoint: A geo-point.
  • # gps_tracking_always: Whether or not to always track the
  • # vehicle.
  • # gps_tracking_day_friday: If not always, then track on Friday.
  • # gps_tracking_day_monday: If not always, then track on Monday.
  • # gps_tracking_day_saturday: If not always, then track on
  • # Saturday.
  • # gps_tracking_day_sunday: If not always, then track on Sunday.
  • # gps_tracking_day_thursday: If not always, then track on
  • # Thursday.
  • # gps_tracking_day_tuesday: If not always, then track on Tuesday.
  • # gps_tracking_day_wednesday: If not always, then track on
  • # Wednesday.
  • # gps_tracking_enabled: Whether or not GPS Tracking enabled for
  • # vehicle.
  • # gps_tracking_end_time: If not always, end time for tracking.
  • # gps_tracking_provider_id: A `GpsTrackingProvider` ID.
  • # gps_tracking_start_time: If not always, start time for
  • # tracking.
  • # gps_tracking_timezone: If not always, timezone for start and
  • # end times.
  • # gps_tracking_uid: A GPS Tracking Provider vehicle unique
  • # identifier.
  • # manufacturer: The manufacturer.
  • # model: The model.
  • # name: A descriptive name.
  • # vin: The vehicle identification number.
  • # year: A year.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • vehicles(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • geopoint: Geopoint,
  • gps_tracking_always: Boolean,
  • gps_tracking_day_friday: Boolean,
  • gps_tracking_day_monday: Boolean,
  • gps_tracking_day_saturday: Boolean,
  • gps_tracking_day_sunday: Boolean,
  • gps_tracking_day_thursday: Boolean,
  • gps_tracking_day_tuesday: Boolean,
  • gps_tracking_day_wednesday: Boolean,
  • gps_tracking_enabled: Boolean,
  • gps_tracking_end_time: Time,
  • gps_tracking_provider_id: Int64Bit,
  • gps_tracking_start_time: Time,
  • gps_tracking_timezone: Timezone,
  • gps_tracking_uid: String,
  • manufacturer: String,
  • model: String,
  • name: String,
  • vin: String,
  • year: Int,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): VehicleConnection!
  • # Availability for `Job`s to be scheduled.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # available: Whether this `ScheduleAvailability` creates
  • # available time, or blocks available time.
  • # geofence_id: The ID of a `Geofence`.
  • # infinite_repetitions: Whether this repeats forever or not.
  • # name: A descriptive name.
  • # repetitions: The number of times this repeats.
  • # start_date: The start date for this `ScheduleAvailability`.
  • # weeks_between_repetitions: The number of weeks between
  • # repetitions.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • schedule_availabilities(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • available: Boolean,
  • geofence_id: Int64Bit,
  • infinite_repetitions: Boolean,
  • name: String,
  • repetitions: Int,
  • start_date: Date,
  • weeks_between_repetitions: Int,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ScheduleAvailabilityConnection!
  • # Time off that removes availability from a `ScheduleAvailability`.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # end_datetime: The date and time that this ends.
  • # name: A descriptive name.
  • # start_datetime: The date and time that this starts.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • schedule_time_offs(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • end_datetime: Datetime,
  • name: String,
  • start_datetime: Datetime,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ScheduleTimeOffConnection!
  • # An event that blocks off part of a calendar otherwise availability due to
  • # `ScheduleAvailability`.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # infinite_repetitions: Whether this repeats forever or not.
  • # name: A descriptive name.
  • # repetitions: The number of times this repeats.
  • # start_date: The start date for this `ScheduleAvailability`.
  • # weeks_between_repetitions: The number of weeks between
  • # repetitions.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • schedule_blockers(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • infinite_repetitions: Boolean,
  • name: String,
  • repetitions: Int,
  • start_date: Date,
  • weeks_between_repetitions: Int,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ScheduleBlockerConnection!
  • # A job, typically in the field.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # complete: Whether or not this is complete.
  • # completed_by_user_id: The `User` that completed this.
  • # completed_successfully: Whether this `Job` was completed
  • # successfully or not.
  • # completion_datetime: The date and time this `Job` was
  • # completed.
  • # completion_notes: Any notes entered when this `Job` was
  • # completed.
  • # job_type_id: The ID of a `JobType`.
  • # jobbable_id: The ID of the entity that this `Job` is associated
  • # with.
  • # jobbable_type: The type of entity that this `Job` is associated
  • # with.
  • # length_in_minutes: The length in minutes for this `Job`.
  • # scheduled_datetime: The date and time this `Job` is scheduled
  • # for.
  • # skips_validation: Indicates this entity has skipped the
  • # validations which would normally apply.
  • # ticket_id: The ID of a `Ticket`.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • jobs(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • complete: Boolean,
  • completed_by_user_id: Int64Bit,
  • completed_successfully: Boolean,
  • completion_datetime: Datetime,
  • completion_notes: Text,
  • job_type_id: Int64Bit,
  • jobbable_id: Int64Bit,
  • jobbable_type: JobbableType,
  • length_in_minutes: Int,
  • scheduled_datetime: Datetime,
  • skips_validation: Boolean,
  • ticket_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): JobConnection!
  • # The geographical point that a technician starts or ends their day at.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # city: A city.
  • # country: A two character country code.
  • # latitude: A decimal latitude.
  • # line1: Address line 1.
  • # line2: Address line 2.
  • # longitude: A decimal longitude.
  • # name: A descriptive name.
  • # subdivision: A state, province, or other country subdivision.
  • # timezone: The timezone you want times in the system displayed
  • # in.
  • # type: The type.
  • # zip: A ZIP or postal code.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • schedule_addresses(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • city: String,
  • country: Country,
  • latitude: Latitude,
  • line1: String,
  • line2: String,
  • longitude: Longitude,
  • name: String,
  • subdivision: Subdivision,
  • timezone: Timezone,
  • type: ScheduleAddressType,
  • zip: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ScheduleAddressConnection!
  • # An alerting rotation.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # all_accounts: Whether to include all account equipment in this
  • # rotation.
  • # all_inventory_models: Whether to include all inventory models
  • # in this rotation.
  • # all_network_sites: Whether to include all network site
  • # equipment in this rotation.
  • # down_time_in_minutes_before_alerting: The number of minutes a
  • # device can be in a down state before generating alert.
  • # down_time_in_minutes_before_repeat: The number of minutes a
  • # device can remain in a down state before sending a repeat alert.
  • # enabled: Whether or not this is enabled.
  • # infinite_repetitions: Whether this repeats forever or not.
  • # name: A descriptive name.
  • # repetitions: The number of times this repeats.
  • # start: The start.
  • # warning_time_in_minutes_before_alerting: The number of minutes
  • # a device can be in a warning state before generating alert.
  • # warning_time_in_minutes_before_repeat: The number of minutes a
  • # device can remain in a warning state before sending a repeat alert.
  • # weeks_between_repetitions: The number of weeks between
  • # repetitions.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • alerting_rotations(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • all_accounts: Boolean,
  • all_inventory_models: Boolean,
  • all_network_sites: Boolean,
  • down_time_in_minutes_before_alerting: Int,
  • down_time_in_minutes_before_repeat: Int,
  • enabled: Boolean,
  • infinite_repetitions: Boolean,
  • name: String,
  • repetitions: Int,
  • start: Date,
  • warning_time_in_minutes_before_alerting: Int,
  • warning_time_in_minutes_before_repeat: Int,
  • weeks_between_repetitions: Int,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AlertingRotationConnection!
  • # A ticket group.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # enabled: Whether or not this is enabled.
  • # name: A descriptive name.
  • # private: If a group is private, only members of the group can
  • # view emails within it.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • ticket_groups(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • enabled: Boolean,
  • name: String,
  • private: Boolean,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): TicketGroupConnection!
  • }

link Require by