OBJECT

Query

link GraphQL Schema definition

  • type Query {
  • # Account billing parameters.
  • #
  • # 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.
  • # auto_pay_day: If `invoice_day` is not null, this allows you to
  • # select whether `auto_pay_days` is calculated from the billing day, or the
  • # invoice day.
  • # auto_pay_days: The number of days after `auto_pay_day` that
  • # auto pay runs for an invoice.
  • # bill_day: The day that billing runs.
  • # bill_mode: The type of bill this account receives.
  • # days_of_delinquency_for_status_switch: If
  • # `switch_status_after_delinquency` is `true`, then this is the number of days of
  • # delinquency to allow before the status switch.
  • # delinquency_account_status_id: If
  • # `switch_status_after_delinquency` is true, this is the account status that the
  • # account will be moved into after `days_of_delinquency_for_status_switch` days of
  • # delinquency.
  • # delinquency_removal_account_status_id: If
  • # `switch_status_after_delinquency` is `true`, then this is the status the account
  • # will be moved back into if delinquency is cleared while the account is set to
  • # the `delinquency_account_status_id` account status.
  • # due_days: The number of days after the invoice date that it is
  • # due.
  • # due_days_day: If `invoice_day` is not null, this allows you to
  • # select whether `due_days` is calculated from the billing day, or the invoice
  • # day.
  • # grace_days: The number of days after the invoice due date that
  • # the invoice is marked delinquent.
  • # grace_until: A temporary override that stops the account
  • # becoming delinquent until this date.
  • # invoice_day: The day that automatic billing invoices are
  • # generated for. If this is `null`, then `bill_day` is used.
  • # months_to_bill: The number of months to bill at a time.
  • # print_invoice: Whether this account receives a printed invoice.
  • # switch_status_after_delinquency: Whether or not this account
  • # should be moved into another status after being delinquent for a preset period.
  • # tax_exempt: Whether or not this account is tax exempt.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • account_billing_parameters(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • auto_pay_day: BillingParameterDayOption,
  • auto_pay_days: Int,
  • bill_day: Int,
  • bill_mode: BillMode,
  • days_of_delinquency_for_status_switch: Int,
  • delinquency_account_status_id: Int64Bit,
  • delinquency_removal_account_status_id: Int64Bit,
  • due_days: Int,
  • due_days_day: BillingParameterDayOption,
  • grace_days: Int,
  • grace_until: Date,
  • invoice_day: Int,
  • months_to_bill: Int,
  • print_invoice: Boolean,
  • switch_status_after_delinquency: Boolean,
  • tax_exempt: Boolean,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccountBillingParameterConnection!
  • # Account groups.
  • #
  • # 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.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • account_groups(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccountGroupConnection!
  • # Services that have been attached to accounts.
  • #
  • # 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.
  • # addition_prorate_date: If this service was prorated when added,
  • # this is the date it was prorated from.
  • # name_override: Overriding the service name will alter the
  • # service name printed on an invoice.
  • # next_bill_date: The next date this service will bill. If this
  • # is null, it will bill on the next account billing date.
  • # number_of_times_billed: The number of times this particular
  • # service has been billed to the customer. This is only used for expiring
  • # services.
  • # package_id: The ID of a `Package`.
  • # price_override: The amount that this service price has been
  • # overridden to. If this is null, then the service price is used.
  • # price_override_reason: The reason that the price of a service
  • # has been overridden.
  • # quantity: The quantity for this service.
  • # service_id: The ID of a Service.
  • # unique_package_relationship_id: A unique ID that describes this
  • # unique instance of a `Package` assignment.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • account_services(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • addition_prorate_date: Date,
  • name_override: String,
  • next_bill_date: Date,
  • number_of_times_billed: Int,
  • package_id: Int64Bit,
  • price_override: Int,
  • price_override_reason: String,
  • quantity: Int,
  • service_id: Int64Bit,
  • unique_package_relationship_id: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccountServiceConnection!
  • # Account statuses.
  • #
  • # 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.
  • # activates_account: Whether or not this status activates the
  • # account.
  • # color: Color.
  • # icon: An icon.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • account_statuses(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • activates_account: Boolean,
  • color: HtmlHexColor,
  • icon: Icon,
  • name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccountStatusConnection!
  • # Account types.
  • #
  • # 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.
  • # color: Color.
  • # icon: An icon.
  • # invoice_message_id: The ID of an `InvoiceMessage`.
  • # name: A descriptive name.
  • # type: The type.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • account_types(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • color: HtmlHexColor,
  • icon: Icon,
  • invoice_message_id: Int64Bit,
  • name: String,
  • type: AccountTypeEnum,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccountTypeConnection!
  • # Customer accounts.
  • #
  • # 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_status_id: The ID of an AccountStatus.
  • # account_type_id: The ID of an AccountType.
  • # activation_date: The date an account was first activated.
  • # company_id: The ID of the company that this entity operates
  • # under.
  • # geopoint: A geo-point.
  • # name: A descriptive name.
  • # next_bill_date: The next date this service will bill. If this
  • # is null, it will bill on the next account billing date.
  • # parent_account_id: The ID of the `Account` that is this
  • # `Account`s master.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • accounts(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_status_id: Int64Bit,
  • account_type_id: Int64Bit,
  • activation_date: Date,
  • company_id: Int64Bit,
  • geopoint: Geopoint,
  • name: String,
  • next_bill_date: Date,
  • parent_account_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccountConnection!
  • # ACH batches.
  • #
  • # 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.
  • # ach_sequence: The batch ID that gets inserted into the ACH file
  • # on generation.
  • # format: The provider to use when transacting against bank
  • # accounts.
  • # payments_after: This batch includes payments after this date.
  • # payments_before: This batch includes payments before this date.
  • # type: Whether this is a batch of debits or credits.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • ach_batches(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • ach_sequence: Int64Bit,
  • format: BankAccountProvider,
  • payments_after: Datetime,
  • payments_before: Datetime,
  • type: AchBatchType,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AchBatchConnection!
  • # Address lists.
  • #
  • # 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_status: The types of account statuses for accounts that
  • # are part of this grouping.
  • # delinquency: The delinquency state for accounts that are part
  • # of this grouping.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • address_lists(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_status: AddressListAccountStatus,
  • delinquency: AddressListDelinquency,
  • name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AddressListConnection!
  • # Geographical addresses.
  • #
  • # 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.
  • # addressable_id: The ID of the entity that owns this address.
  • # addressable_type: The type of entity that owns this address.
  • # city: A city.
  • # country: A two character country code.
  • # county: A US county. Only used for US addresses.
  • # fips: Only used in the USA, this is the census tract
  • # information used for calculating things like FCC Form 477.
  • # latitude: A decimal latitude.
  • # line1: Address line 1.
  • # line2: Address line 2.
  • # longitude: A decimal longitude.
  • # serviceable: Whether or not the address is serviceable, and can
  • # be used for new accounts.
  • # subdivision: A state, province, or other country subdivision.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • addresses(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • addressable_id: Int64Bit,
  • addressable_type: AddressableType,
  • city: String,
  • country: Country,
  • county: UsCounty,
  • fips: String,
  • latitude: Latitude,
  • line1: String,
  • line2: String,
  • longitude: Longitude,
  • serviceable: Boolean,
  • subdivision: Subdivision,
  • type: AddressType,
  • zip: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AddressConnection!
  • # Details related to an adjustment service.
  • #
  • # 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 that can be adjusted using these service
  • # within the period defined in `adjustment_service_days`.
  • # days: The period of time in which transactions are tracked to
  • # calculate against the total defined in `adjustment_service_amount`.
  • # service_id: The ID of a 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • adjustment_service_details(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • amount: Int,
  • days: Int,
  • service_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AdjustmentServiceDetailConnection!
  • # Alerting rotation days and times.
  • #
  • # 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.
  • # alerting_rotation_id: The alerting rotation ID.
  • # day: A day.
  • # end_time: The end time for the day.
  • # start_time: The start time for the day.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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_rotation_days(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • alerting_rotation_id: Int64Bit,
  • day: Day,
  • end_time: Time,
  • start_time: Time,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AlertingRotationDayConnection!
  • # Inventory items associated with alerting rotations.
  • #
  • # 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.
  • # alerting_rotation_id: The alerting rotation ID.
  • # inventory_item_id: The ID of an `InventoryItem`.
  • # last_alerted_datetime: The date and time that this rotation was
  • # last notified of a status change.
  • # last_overall_status: The last monitoring status of an inventory
  • # item.
  • # last_status_change_datetime: The date and time that the
  • # inventory item status last changed.
  • # next_alert_datetime: The next date and time to send a status
  • # alert for this rotation.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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_rotation_inventory_items(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • alerting_rotation_id: Int64Bit,
  • inventory_item_id: Int64Bit,
  • last_alerted_datetime: Datetime,
  • last_overall_status: InventoryItemDeviceStatus,
  • last_status_change_datetime: Datetime,
  • next_alert_datetime: Datetime,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AlertingRotationInventoryItemConnection!
  • # Alerting rotations.
  • #
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AlertingRotationConnection!
  • # Application firewall rules.
  • #
  • # 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.
  • # description: A human readable description.
  • # subnet: An IPv4/IPv6 subnet.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • application_firewall_rules(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • description: String,
  • subnet: SubnetScalar,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ApplicationFirewallRuleConnection!
  • # Available explores.
  • available_explores: AvailableExploresConnection!
  • # Available reports.
  • available_reports: AvailableReportsConnection!
  • # Bank account processor credentials.
  • #
  • # 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.
  • # bank_account_processor_id: The ID of a BankProcessor.
  • # credential: The credential name.
  • # value: The value.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • bank_account_processor_credentials(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • bank_account_processor_id: Int64Bit,
  • credential: BankAccountProviderCredential,
  • value: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): BankAccountProcessorCredentialConnection!
  • # Processors of transactions to and from bank accounts.
  • #
  • # 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.
  • # primary: Whether or not this is the primary type of entity.
  • # provider: The provider for this processor.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • bank_account_processors(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • enabled: Boolean,
  • primary: Boolean,
  • provider: BankAccountProvider,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): BankAccountProcessorConnection!
  • # Bank accounts.
  • #
  • # 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.
  • # auto: Whether or not this payment method is enabled for
  • # automatic payments.
  • # bank_account_processor_id: The ID of a BankProcessor.
  • # bank_account_type: The type of bank account this is.
  • # customer_profile_id: The profile ID provided by a credit card
  • # processing service.
  • # masked_account_number: A partial account number that can be
  • # used for identification.
  • # name_on_account: The name on the account.
  • # routing_number: The bank routing number.
  • # token: The tokenized value that represents a credit card,
  • # provided by a credit card processing 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • bank_accounts(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • auto: Boolean,
  • bank_account_processor_id: Int64Bit,
  • bank_account_type: BankAccountType,
  • customer_profile_id: String,
  • masked_account_number: String,
  • name_on_account: String,
  • routing_number: String,
  • token: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): BankAccountConnection!
  • # Default billing values for new accounts.
  • #
  • # 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_type_id: The ID of an AccountType.
  • # auto_pay_day: If `invoice_day` is not null, this allows you to
  • # select whether `auto_pay_days` is calculated from the billing day, or the
  • # invoice day.
  • # auto_pay_days: The number of days after `auto_pay_day` that
  • # auto pay runs for an invoice.
  • # bill_day: The day that billing runs.
  • # bill_mode: The type of bill this account receives.
  • # days_of_delinquency_for_status_switch: If
  • # `switch_status_after_delinquency` is `true`, then this is the number of days of
  • # delinquency to allow before the status switch.
  • # default: If this is `true`, then this is the default billing
  • # default that is used, if there is no more specific billing default option for an
  • # account.
  • # delinquency_account_status_id: If
  • # `switch_status_after_delinquency` is true, this is the account status that the
  • # account will be moved into after `days_of_delinquency_for_status_switch` days of
  • # delinquency.
  • # delinquency_removal_account_status_id: If
  • # `switch_status_after_delinquency` is `true`, then this is the status the account
  • # will be moved back into if delinquency is cleared while the account is set to
  • # the `delinquency_account_status_id` account status.
  • # due_days: The number of days after the invoice date that it is
  • # due.
  • # due_days_day: If `invoice_day` is not null, this allows you to
  • # select whether `due_days` is calculated from the billing day, or the invoice
  • # day.
  • # fixed_bill_day: Whether or not to use a fixed bill day, versus
  • # anniversary day billing.
  • # grace_days: The number of days after the invoice due date that
  • # the invoice is marked delinquent.
  • # invoice_day: The day that automatic billing invoices are
  • # generated for. If this is `null`, then `bill_day` is used.
  • # months_to_bill: The number of months to bill at a time.
  • # name: A descriptive name.
  • # print_invoice: Whether this account receives a printed invoice.
  • # switch_status_after_delinquency: Whether or not this account
  • # should be moved into another status after being delinquent for a preset period.
  • # tax_exempt: Whether or not this account is tax exempt.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • billing_defaults(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_type_id: Int64Bit,
  • auto_pay_day: BillingParameterDayOption,
  • auto_pay_days: Int,
  • bill_day: Int,
  • bill_mode: BillMode,
  • days_of_delinquency_for_status_switch: Int,
  • default: Boolean,
  • delinquency_account_status_id: Int64Bit,
  • delinquency_removal_account_status_id: Int64Bit,
  • due_days: Int,
  • due_days_day: BillingParameterDayOption,
  • fixed_bill_day: Boolean,
  • grace_days: Int,
  • invoice_day: Int,
  • months_to_bill: Int,
  • name: String,
  • print_invoice: Boolean,
  • switch_status_after_delinquency: Boolean,
  • tax_exempt: Boolean,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): BillingDefaultConnection!
  • # Billing settings.
  • billing_setting: BillingSetting!
  • # Cable modem provisioner credentials.
  • #
  • # 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.
  • # cable_modem_provisioner_id: The ID of a
  • # `CableModemProvisioner`.
  • # credential: An individual credential to authenticate to a cable
  • # modem provisioner.
  • # value: The credential value (e.g. username, password, etc.)
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • cable_modem_provisioner_credentials(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • cable_modem_provisioner_id: Int64Bit,
  • credential: CableModemProvisionerAuthenticationCredential,
  • value: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CableModemProvisionerCredentialConnection!
  • # Cable modem provisioners.
  • #
  • # 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.
  • # hostname: Hostname.
  • # last_synchronized: The date and time this device was last
  • # synchronized.
  • # name: A descriptive name.
  • # status: The status.
  • # status_message: A message describing what caused the current
  • # status of this device.
  • # synchronization_queued: Whether or not a synchronization
  • # request is queued.
  • # synchronization_start: The date/time that synchronization
  • # started.
  • # type: The type.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • cable_modem_provisioners(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • enabled: Boolean,
  • hostname: String,
  • last_synchronized: Datetime,
  • name: String,
  • status: ProvisioningDeviceStatus,
  • status_message: String,
  • synchronization_queued: Boolean,
  • synchronization_start: Datetime,
  • type: CableModemProvisionerType,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CableModemProvisionerConnection!
  • # Call Logs for accounts.
  • #
  • # 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.
  • # body: The body.
  • # subject: The subject.
  • # time_in_seconds: The time in seconds.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • call_logs(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • body: Text,
  • subject: String,
  • time_in_seconds: String,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CallLogConnection!
  • # Canned replies.
  • #
  • # 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.
  • # canned_reply_category_id: The ID of a `CannedReplyCategory`.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • canned_replies(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • body: Text,
  • canned_reply_category_id: Int64Bit,
  • name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CannedReplyConnection!
  • # Canned reply categories.
  • #
  • # 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.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • canned_reply_categories(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CannedReplyCategoryConnection!
  • # Canned reply with variable replacement.
  • #
  • # Arguments
  • # canned_reply_id: fields.canned_reply_id
  • # ticket_id: The ID of a `Ticket`.
  • canned_reply_with_variable_replacement(
  • canned_reply_id: Int64Bit!,
  • ticket_id: Int64Bit!
  • ): CannedReply!
  • # Companies that you do business as.
  • #
  • # 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.
  • # checks_payable_to: On an enabled remittance slip, who should
  • # checks be made payable to?
  • # country: A two character country code.
  • # customer_portal_url: The URL to your customer portal.
  • # default: Whether or not this entity is a default entry.
  • # enabled: Whether or not this is enabled.
  • # name: A descriptive name.
  • # phone_number: A telephone number.
  • # primary_color: The primary color to use in Sonar.
  • # secondary_color: The secondary color to use in Sonar.
  • # show_remittance_slip: Whether or not to include a detachable
  • # remittance slip on the invoice.
  • # tax_identification: A tax identification number. Should only be
  • # entered if you are required to share some type of tax identification information
  • # with your customers.
  • # website_address: The address of the company website.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • companies(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • checks_payable_to: String,
  • country: Country,
  • customer_portal_url: URL,
  • default: Boolean,
  • enabled: Boolean,
  • name: String,
  • phone_number: Numeric,
  • primary_color: HtmlHexColor,
  • secondary_color: HtmlHexColor,
  • show_remittance_slip: Boolean,
  • tax_identification: String,
  • website_address: URL,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CompanyConnection!
  • # A contact person.
  • #
  • # 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.
  • # contactable_id: The ID of the entity that owns this contact.
  • # contactable_type: The type of entity that owns this contact.
  • # email_address: An email address.
  • # language: A supported language.
  • # name: A descriptive name.
  • # primary: Whether or not this is the primary type of entity.
  • # role: The role of the contact, e.g. "CEO" or "Network
  • # Engineer".
  • # username: A username, used for authentication.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • contacts(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • contactable_id: Int64Bit,
  • contactable_type: ContactableType,
  • email_address: EmailAddress,
  • language: Language,
  • name: String,
  • primary: Boolean,
  • role: String,
  • username: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ContactConnection!
  • # Contract templates.
  • #
  • # 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.
  • # company_id: The ID of the company that this entity operates
  • # under.
  • # enabled: Whether or not this is enabled.
  • # name: A descriptive name.
  • # term_in_months: The term in months.
  • # ticket_group_id: The ID of a `TicketGroup`.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • contract_templates(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • body: Text,
  • company_id: Int64Bit,
  • enabled: Boolean,
  • name: String,
  • term_in_months: Int,
  • ticket_group_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ContractTemplateConnection!
  • # Contracts.
  • #
  • # 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.
  • # body: The body.
  • # contact_id: The ID of the contact that owns this.
  • # contract_template_id: The ID of a `ContractTemplate`.
  • # custom_message: The custom message.
  • # expiration_date: The expiration date.
  • # handwritten_signature_id: The ID of a `HandwrittenSignature`.
  • # name: A descriptive name.
  • # term_in_months: The term in months.
  • # unique_link_key: Part of the unique URL used for signing.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • contracts(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • body: Text,
  • contact_id: Int64Bit,
  • contract_template_id: Int64Bit,
  • custom_message: Text,
  • expiration_date: Date,
  • handwritten_signature_id: Int64Bit,
  • name: String,
  • term_in_months: Int,
  • unique_link_key: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ContractConnection!
  • # Core credit cards.
  • #
  • # 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.
  • # auto: Whether or not this payment method is enabled for
  • # automatic payments.
  • # credit_card_processor_id: The ID of a CreditCardProcessor.
  • # credit_card_type: The type of a credit card (e.g. Visa,
  • # Mastercard.)
  • # customer_profile_id: The profile ID provided by a credit card
  • # processing service.
  • # expiration_month: The month the credit card expires.
  • # expiration_year: The year the credit card expires.
  • # masked_number: A partial credit card number that can be used
  • # for identification.
  • # name_on_card: The name on the credit card.
  • # token: The tokenized value that represents a credit card,
  • # provided by a credit card processing 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • core_credit_cards(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • auto: Boolean,
  • credit_card_processor_id: Int64Bit,
  • credit_card_type: CreditCardType,
  • customer_profile_id: String,
  • expiration_month: Int,
  • expiration_year: Int,
  • masked_number: String,
  • name_on_card: String,
  • token: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CoreCreditCardConnection!
  • # Core invoices.
  • #
  • # 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.
  • # auto_pay_attempts: The number of times that auto pay has been
  • # attempted.
  • # auto_pay_date: The date that auto pay will be attempted.
  • # child_invoice_remaining_due: The sum of all due amounts on
  • # child invoices.
  • # company_id: The ID of the company that this entity operates
  • # under.
  • # date: A date
  • # delinquency_date: The date that this became delinquent.
  • # delinquent: Whether or not this entity is delinquent.
  • # due_date: The date this invoice is due by.
  • # end_date: The date that this ends.
  • # frozen: If an invoice is frozen, payments will not be
  • # automatically applied to it, and it cannot be modified.
  • # late_fee_applied: Whether or not a late fee has been applied.
  • # message: The message.
  • # number_of_months: The number of months of service this invoice
  • # was billed for.
  • # parent_invoice_id: The ID of the `Invoice` that is this
  • # `Invoice`s master.
  • # remaining_due: The amount remaining to be paid.
  • # total_debits: The sum of all debits that make up this invoice.
  • # total_taxes: The sum of all taxes on debits that make up this
  • # invoice.
  • # void: Whether or not this entity has been voided.
  • # voided_at: When this was voided.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • core_invoices(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • auto_pay_attempts: Int,
  • auto_pay_date: Date,
  • child_invoice_remaining_due: Int,
  • company_id: Int64Bit,
  • date: Date,
  • delinquency_date: Date,
  • delinquent: Boolean,
  • due_date: Date,
  • end_date: Date,
  • frozen: Boolean,
  • late_fee_applied: Boolean,
  • message: Text,
  • number_of_months: Int,
  • parent_invoice_id: Int64Bit,
  • remaining_due: Int,
  • total_debits: Int,
  • total_taxes: Int,
  • void: Boolean,
  • voided_at: Datetime,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CoreInvoiceConnection!
  • # Core transactions.
  • #
  • # 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.)
  • # datetime: A date and time
  • # description: A human readable description.
  • # running_balance: The balance in relation to prior transactions.
  • # type: The type.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • core_transactions(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • amount: Int,
  • datetime: Datetime,
  • description: String,
  • running_balance: Int,
  • type: TransactionType,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CoreTransactionConnection!
  • # Credit card processor credentials.
  • #
  • # 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.
  • # credential: The credential name.
  • # credit_card_processor_id: The ID of a CreditCardProcessor.
  • # value: The value.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • credit_card_processor_credentials(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • credential: CreditCardProviderCredential,
  • credit_card_processor_id: Int64Bit,
  • value: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CreditCardProcessorCredentialConnection!
  • # Credit card processors configured in Sonar.
  • #
  • # 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.
  • # amex: American Express.
  • # dankort: Dankort.
  • # dinersclub: Diner's Club.
  • # discover: Discover.
  • # enabled: Whether or not this is enabled.
  • # forbrugsforeningen: Forbrugsforeningen.
  • # jcb: JCB
  • # maestro: Maestro.
  • # mastercard: MasterCard.
  • # primary: Whether or not this is the primary type of entity.
  • # provider: The company that provides credit card processing
  • # services.
  • # unionpay: Union Pay.
  • # visa: Visa
  • # visaelectron: VISA Electron.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • credit_card_processors(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • amex: Boolean,
  • dankort: Boolean,
  • dinersclub: Boolean,
  • discover: Boolean,
  • enabled: Boolean,
  • forbrugsforeningen: Boolean,
  • jcb: Boolean,
  • maestro: Boolean,
  • mastercard: Boolean,
  • primary: Boolean,
  • provider: CreditCardProvider,
  • unionpay: Boolean,
  • visa: Boolean,
  • visaelectron: Boolean,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CreditCardProcessorConnection!
  • # Credit cards.
  • #
  • # 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.
  • # auto: Whether or not this payment method is enabled for
  • # automatic payments.
  • # credit_card_processor_id: The ID of a CreditCardProcessor.
  • # credit_card_type: The type of a credit card (e.g. Visa,
  • # Mastercard.)
  • # customer_profile_id: The profile ID provided by a credit card
  • # processing service.
  • # expiration_month: The month the credit card expires.
  • # expiration_year: The year the credit card expires.
  • # masked_number: A partial credit card number that can be used
  • # for identification.
  • # name_on_card: The name on the credit card.
  • # token: The tokenized value that represents a credit card,
  • # provided by a credit card processing 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • credit_cards(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • auto: Boolean,
  • credit_card_processor_id: Int64Bit,
  • credit_card_type: CreditCardType,
  • customer_profile_id: String,
  • expiration_month: Int,
  • expiration_year: Int,
  • masked_number: String,
  • name_on_card: String,
  • token: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CreditCardConnection!
  • # Credits applied to invoices.
  • #
  • # 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.)
  • # creditable_id: The ID the transaction that created this credit.
  • # creditable_type: The type of transaction that created this
  • # credit.
  • # invoice_id: The ID of an `Invoice`.
  • # void: Whether or not this entity has been voided.
  • # voided_at: When this was voided.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • credits(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • amount: Int,
  • creditable_id: Int64Bit,
  • creditable_type: CreditableType,
  • invoice_id: Int64Bit,
  • void: Boolean,
  • voided_at: Datetime,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CreditConnection!
  • # Data in custom fields.
  • #
  • # 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.
  • # custom_field_id: The ID of a CustomField that is associated
  • # with this type of entity.
  • # customfielddataable_id: The ID of the entity that owns this
  • # custom field data.
  • # customfielddataable_type: The type of entity that owns this
  • # custom field data.
  • # value: The value.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • custom_field_data(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • custom_field_id: Int64Bit,
  • customfielddataable_id: Int64Bit,
  • customfielddataable_type: CustomfielddataableType,
  • value: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CustomFieldDataConnection!
  • # Custom fields.
  • #
  • # 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.
  • # entity_type: The type of entity this custom field will be
  • # associated with.
  • # enum_options: A list of values that are valid for this field,
  • # if this is a TEXT field. If this is empty, and the field is a TEXT type, then
  • # any value will be allowed.
  • # name: A descriptive name.
  • # required: Whether or not this field is required.
  • # type: The type.
  • # unique: Whether or not the value of this custom field must be
  • # unique throughout the system.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • custom_fields(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • entity_type: CustomfielddataableType,
  • enum_options: [String],
  • name: String,
  • required: Boolean,
  • type: CustomFieldType,
  • unique: Boolean,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CustomFieldConnection!
  • # Aggregate values for a given date.
  • #
  • # 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.
  • # context: Additional context regarding the item.
  • # date: A date
  • # key: Key for a specific value.
  • # value: The value.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • daily_aggregate_values(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • context: Text,
  • date: Date,
  • key: AggregateKey,
  • value: Float,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DailyAggregateValueConnection!
  • # Details related to a data service.
  • #
  • # 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.
  • # billing_frequency: How often this service bills, in months.
  • # download_speed_kilobits_per_second: The download speed of the
  • # service in kilobits per second.
  • # service_id: The ID of a Service.
  • # technology_code: The FCC technology code for the service. Only
  • # relevant to US ISPs filing FCC Form 477.
  • # telrad_global_service_profile_name: The global service profile
  • # name for this service if using Telrad provisioning.
  • # upload_speed_kilobits_per_second: The upload speed of the
  • # service in kilobits per second.
  • # usage_based_billing_policy_id: The ID of a
  • # `UsageBasedBillingPolicy`.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • data_service_details(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • billing_frequency: Int,
  • download_speed_kilobits_per_second: Int,
  • service_id: Int64Bit,
  • technology_code: TechnologyCode,
  • telrad_global_service_profile_name: String,
  • upload_speed_kilobits_per_second: Int,
  • usage_based_billing_policy_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DataServiceDetailConnection!
  • # Data usage.
  • #
  • # Arguments
  • # start_datetime: The date and time that this starts.
  • # end_datetime: The date and time that this ends.
  • # time: The time.
  • # account_id: The ID of an Account.
  • data_usage(
  • start_datetime: Datetime,
  • end_datetime: Datetime,
  • time: Datetime,
  • account_id: Int64Bit!
  • ): [DataUsage]!
  • # Data usage history.
  • #
  • # 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.
  • # billable_in_bytes: The total billable inbound data in bytes.
  • # billable_out_bytes: The total billable outbound data in bytes.
  • # end_time: The end time of this data usage history interval.
  • # free_in_bytes: The total free inbound data in bytes.
  • # free_out_bytes: The total free outbound data in bytes.
  • # start_time: The start time of this data usage history interval.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • data_usage_histories(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • billable_in_bytes: Int64Bit,
  • billable_out_bytes: Int64Bit,
  • end_time: Datetime,
  • free_in_bytes: Int64Bit,
  • free_out_bytes: Int64Bit,
  • start_time: Datetime,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DataUsageHistoryConnection!
  • # Data usage top offs.
  • #
  • # 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_in_bytes: The amount of top off data in bytes.
  • # data_usage_history_id: The ID of a `DataUsageHistory`.
  • # debit_id: The ID of a `Debit`.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • data_usage_top_offs(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • amount_in_bytes: Int64Bit,
  • data_usage_history_id: Int64Bit,
  • debit_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DataUsageTopOffConnection!
  • # Debits.
  • #
  • # 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`.
  • # 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.
  • # service_id: The ID of a Service.
  • # service_name: The name of a service.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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,
  • 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,
  • service_id: Int64Bit,
  • service_name: String,
  • type: ServiceType,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DebitConnection!
  • # Periods of time in which delinquency is not calculated.
  • #
  • # 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.
  • # day: A day.
  • # month: A month.
  • # name: A descriptive name.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • delinquency_exclusions(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • day: Int,
  • month: Int,
  • name: String,
  • year: Int,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DelinquencyExclusionConnection!
  • # Modes in which a piece of inventory can be deployed.
  • #
  • # 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.
  • # inventory_model_id: The ID of an `InventoryModel`.
  • # name: A descriptive name.
  • # network_monitoring_template_id: The ID of a
  • # `NetworkMonitoringTemplate`.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • deployment_types(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • inventory_model_id: Int64Bit,
  • name: String,
  • network_monitoring_template_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DeploymentTypeConnection!
  • # Deposit slips.
  • #
  • # 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.
  • # bank_account_line: The bank account name/number
  • # date: A date
  • # memo: The memo.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • deposit_slips(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • bank_account_line: String,
  • date: Date,
  • memo: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DepositSlipConnection!
  • # Device interface mappings.
  • #
  • # 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.
  • # description: A human readable description.
  • # inventory_item_id: The ID of an `InventoryItem`.
  • # mac_address: A MAC address.
  • # metadata: The metadata.
  • # speed_mbps_in: The interface in speed in Mbps.
  • # speed_mbps_out: The interface out speed in Mbps.
  • # type: The type.
  • # up: Whether or not this interface is up.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • device_interface_mappings(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • description: String,
  • inventory_item_id: Int64Bit,
  • mac_address: MacAddress,
  • metadata: Text,
  • speed_mbps_in: Int,
  • speed_mbps_out: Int,
  • type: String,
  • up: Boolean,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DeviceInterfaceMappingConnection!
  • # DHCP server credentials.
  • #
  • # 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.
  • # credential: A credential for a `DhcpServer`.
  • # dhcp_server_id: The ID of a `DhcpServer`.
  • # value: The value of a credential for a `DhcpServer`.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • dhcp_server_credentials(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • credential: DhcpServerAuthenticationCredential,
  • dhcp_server_id: Int64Bit,
  • value: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DhcpServerCredentialConnection!
  • # DHCP sever identifiers.
  • #
  • # 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.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • dhcp_server_identifiers(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DhcpServerIdentifierConnection!
  • # DHCP servers.
  • #
  • # 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.
  • # api_key: An API key.
  • # enabled: Whether or not this is enabled.
  • # ip_address: An IPv4/IPv6 address.
  • # last_synchronized: The date and time this device was last
  • # synchronized.
  • # name: A descriptive name.
  • # port: A TCP port.
  • # serves_all_pools: Does this `DhcpServer` provide DHCP for all
  • # IP pools?
  • # status: The status.
  • # status_message: A message describing what caused the current
  • # status of this device.
  • # synchronization_queued: Whether or not a synchronization
  • # request is queued.
  • # synchronization_start: The date/time that synchronization
  • # started.
  • # type: The type.
  • # use_source_mac_address: If this is `true`, then Sonar will use
  • # the MAC address of the DHCP relay rather than the MAC address of the requesting
  • # device when writing a lease. This should generally be disabled unless you have a
  • # specific reason to enable 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • dhcp_servers(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • api_key: String,
  • enabled: Boolean,
  • ip_address: IP,
  • last_synchronized: Datetime,
  • name: String,
  • port: Port,
  • serves_all_pools: Boolean,
  • status: ProvisioningDeviceStatus,
  • status_message: String,
  • synchronization_queued: Boolean,
  • synchronization_start: Datetime,
  • type: DhcpServerType,
  • use_source_mac_address: Boolean,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DhcpServerConnection!
  • # Disconnection logs.
  • #
  • # 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.
  • # disconnected_at: The date and time that the account was
  • # disconnected.
  • # disconnected_by_user_id: The `User` that disconnected the
  • # `Account`.
  • # serviceable_address_id: The ID of the serviceable address to
  • # use for this account.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • disconnection_logs(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • disconnected_at: Datetime,
  • disconnected_by_user_id: Int64Bit,
  • serviceable_address_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DisconnectionLogConnection!
  • # Discounts.
  • #
  • # 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.
  • # 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.
  • # service_id: The ID of a Service.
  • # service_name: The name of a service.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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,
  • prorated_from: Date,
  • prorated_to: Date,
  • quantity: Int,
  • quantity_prorated_from: Int,
  • quantity_prorated_to: Int,
  • reversed: Boolean,
  • reversed_at: Datetime,
  • service_id: Int64Bit,
  • service_name: String,
  • type: ServiceType,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DiscountConnection!
  • # Drive times.
  • #
  • # Arguments
  • # locations: fields.drive_time_locations
  • drive_times(locations: [DriveTimeLocation]!): DriveTimeResultWrapper
  • # Validate contact email address.
  • #
  • # Arguments
  • # email_address: An email address.
  • # check_if_available: If true, this checks if the contact does
  • # not have a username. If this is false, then it will check if the account has a
  • # username.
  • email_address_lookup(
  • email_address: String!,
  • check_if_available: Boolean
  • ): Contact!
  • # Email categories are associated with contacts, and define the types of emails
  • # those contacts receive. The "default" property determines whether or not the
  • # category is added to newly created contacts by default.
  • #
  • # 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.
  • # default: Whether or not this entity is a default entry.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • email_categories(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • default: Boolean,
  • name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): EmailCategoryConnection!
  • # All clicks for each sent 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.
  • # email_id: The ID of an email.
  • # email_location_id: The ID of a location associated with a
  • # record in EmailClick and EmailOpen.
  • # event_datetime: The date and time of an event sent from
  • # Mandrill
  • # ip: An IPv4/IPv6 address.
  • # url: The URL that a user clicked on in a sent email.
  • # user_agent: The user agent string of a user that opened or
  • # clicked on a sent email.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • email_clicks(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • email_id: Int64Bit,
  • email_location_id: Int64Bit,
  • event_datetime: Datetime,
  • ip: IP,
  • url: URL,
  • user_agent: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): EmailClickConnection!
  • # Email domains.
  • #
  • # 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.
  • # dkim: Whether or not the DKIM record is valid.
  • # domain: A domain name.
  • # spf: Whether or not the SPF record is valid.
  • # verified: Whether or not the record is verified.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • email_domains(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • dkim: Boolean,
  • domain: DomainName,
  • spf: Boolean,
  • verified: Boolean,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): EmailDomainConnection!
  • # Get a list of all locations saved for opened and clicked emails.
  • #
  • # 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.
  • # longitude: A decimal longitude.
  • # postal_code: The zip code of an email location sent by a
  • # Mandrill event.
  • # timezone: The timezone you want times in the system displayed
  • # in.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • email_locations(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • city: String,
  • country: String,
  • latitude: Latitude,
  • longitude: Longitude,
  • postal_code: String,
  • timezone: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): EmailLocationConnection!
  • # Localized email message details for an EmailMessage container.
  • #
  • # 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_message_id: The ID of an EmailMessage.
  • # inbox_preview: A short sentence that will be shown as a preview
  • # in compatible email clients.
  • # language: A supported language.
  • # subject: The subject.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • email_message_contents(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • body: Text,
  • email_message_id: Int64Bit,
  • inbox_preview: String,
  • language: Language,
  • subject: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): EmailMessageContentConnection!
  • # Email message templates.
  • #
  • # 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.
  • # from_email_address: The email address to send from when using
  • # this email message. If `null`, then the system default will be used.
  • # from_name: The name to send from when using this email message.
  • # If `null`, then the system default will be used.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • email_messages(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • from_email_address: EmailAddress,
  • from_name: String,
  • name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): EmailMessageConnection!
  • # All opens for each sent 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.
  • # email_id: The ID of an email.
  • # email_location_id: The ID of a location associated with a
  • # record in EmailClick and EmailOpen.
  • # event_datetime: The date and time of an event sent from
  • # Mandrill
  • # ip: An IPv4/IPv6 address.
  • # user_agent: The user agent string of a user that opened or
  • # clicked on a sent email.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • email_opens(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • email_id: Int64Bit,
  • email_location_id: Int64Bit,
  • event_datetime: Datetime,
  • ip: IP,
  • user_agent: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): EmailOpenConnection!
  • # Get a list of valid email variables for a specific email trigger.
  • #
  • # Arguments
  • # trigger: The event that triggers a specific `Email`.
  • email_variables(trigger: EmailTrigger): [EmailVariable]
  • # Emails that have been sent.
  • #
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): EmailConnection!
  • # LTE EPCs.
  • #
  • # 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.
  • # identifier: The identifier used by the EPC, this is typically
  • # numeric.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • epcs(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • identifier: String,
  • name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): EpcConnection!
  • # Details related to an expiring service.
  • #
  • # 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.
  • # billing_frequency: How often this service bills, in months.
  • # service_id: The ID of a Service.
  • # times_to_run: The number of times this expiring service should
  • # run.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • expiring_service_details(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • billing_frequency: Int,
  • service_id: Int64Bit,
  • times_to_run: Int,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ExpiringServiceDetailConnection!
  • # External marketing provider credentials.
  • #
  • # 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.
  • # external_marketing_provider_id: The ID of an
  • # `ExternalMarketingProvider`.
  • # key: Key for a specific value.
  • # value: The value.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • external_marketing_provider_credentials(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • external_marketing_provider_id: Int64Bit,
  • key: ExternalMarketingProviderAuthCredential,
  • value: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ExternalMarketingProviderCredentialConnection!
  • # External marketing providers.
  • #
  • # 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.
  • # provider: The `ExternalMarketingProviderType` for 3rd party
  • # external marketing integration.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • external_marketing_providers(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • enabled: Boolean,
  • provider: ExternalMarketingProviderType,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ExternalMarketingProviderConnection!
  • # The generated FCC Form 477 report.
  • #
  • # 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
  • # format: The format of the reporting for FCC Form 477.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • fcc_form_477_reports(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • date: Date,
  • format: FccForm477Format,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): FccForm477ReportConnection!
  • # Files.
  • #
  • # 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.
  • # description: A human readable description.
  • # file_size_in_bytes: The file size, in bytes.
  • # fileable_id: The ID of the entity that owns this file.
  • # fileable_type: The type of entity that owns this file.
  • # filename: The file name.
  • # mime_type: The MIME type of the file.
  • # primary_image: An image file may be set to the primary image.
  • # This will be used as the displayed image for the object that this file is
  • # associated to throughout Sonar.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • files(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • description: String,
  • file_size_in_bytes: Int64Bit,
  • fileable_id: Int64Bit,
  • fileable_type: FileableType,
  • filename: String,
  • mime_type: String,
  • primary_image: Boolean,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): FileConnection!
  • # General ledger codes.
  • #
  • # 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.
  • # code: A code.
  • # description: A human readable description.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • general_ledger_codes(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • code: String,
  • description: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): GeneralLedgerCodeConnection!
  • # This query provides the ability to perform a general, partial matching search
  • # across various entities at the same time.
  • #
  • # Arguments
  • # paginator: Provides the ability to paginate through results.
  • # entities: fields.general_search_entities
  • # search: fields.general_search_search
  • general_search(
  • paginator: Paginator,
  • entities: [String]!,
  • search: String!
  • ): GeneralSearchConnection!
  • # Generic inventory assignees.
  • #
  • # 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.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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_assignees(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): GenericInventoryAssigneeConnection!
  • # Logs of changes made to generic inventory items.
  • #
  • # 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.
  • # action: The action that was performed.
  • # genericinventoryitemactionloggable_id: The ID of the entity
  • # that this `GenericInventoryItemActionLog` is for.
  • # genericinventoryitemactionloggable_type: The type of entity
  • # that this `GenericInventoryItemActionLog` is for.
  • # inventory_model_id: The ID of an `InventoryModel`.
  • # purchase_price: The purchase price of this item.
  • # quantity: The quantity for this service.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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_item_action_logs(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • action: GenericInventoryItemActionLogAction,
  • genericinventoryitemactionloggable_id: Int64Bit,
  • genericinventoryitemactionloggable_type: InventoryitemableType,
  • inventory_model_id: Int64Bit,
  • purchase_price: Float,
  • quantity: Int,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): GenericInventoryItemActionLogConnection!
  • # Generic inventory items.
  • #
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): GenericInventoryItemConnection!
  • # Geographical tax zones.
  • #
  • # 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.
  • # county: A US county. Only used for US addresses.
  • # name: A descriptive name.
  • # rate: The rate.
  • # subdivision: A state, province, or other country subdivision.
  • # tax_id: The ID of a Tax.
  • # zip: A ZIP or postal code.
  • # zip_partial_match: Whether to match on partial ZIP/postal
  • # codes.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • geo_tax_zones(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • city: String,
  • country: Country,
  • county: UsCounty,
  • name: String,
  • rate: Float,
  • subdivision: Subdivision,
  • tax_id: Int64Bit,
  • zip: String,
  • zip_partial_match: Boolean,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): GeoTaxZoneConnection!
  • # Geofences.
  • #
  • # 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.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • geofences(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): GeofenceConnection!
  • # Returns the next IP address in the IP pool.
  • #
  • # Arguments
  • # ip_pool_id: The ID of an `IpPool`.
  • get_next_ip_address_in_ip_pool(
  • ip_pool_id: Int64Bit!
  • ): NextIpAddress!
  • # Returns the next subnet in the subnet.
  • #
  • # Arguments
  • # subnet_id: The ID of a `Subnet`.
  • # cidr_size: fields.cidr_size
  • get_next_subnet_in_subnet(
  • subnet_id: Int64Bit!,
  • cidr_size: Int!
  • ): NextSubnet!
  • # Returns the next available subnet of the requested size in the supernet.
  • #
  • # Arguments
  • # supernet_id: The ID of a `Supernet`.
  • # cidr_size: fields.cidr_size
  • get_next_subnet_in_supernet(
  • supernet_id: Int64Bit!,
  • cidr_size: Int!
  • ): NextSubnet!
  • # GPS tracking provider.
  • gps_tracking_provider: GpsTrackingProvider!
  • # GPS tracking provider credentials.
  • #
  • # 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.
  • # gps_tracking_provider_id: A `GpsTrackingProvider` ID.
  • # key: Key for a specific value.
  • # value: The value.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • gps_tracking_provider_credentials(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • gps_tracking_provider_id: Int,
  • key: GpsTrackingProviderAuthCredential,
  • value: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): GpsTrackingProviderCredentialConnection!
  • # Signatures on signed contracts.
  • #
  • # 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.
  • # contact_email_address: The email address of the contact that
  • # the contract was originally sent to.
  • # contact_name: The name of the contact that the contract was
  • # originally sent to.
  • # contact_role: The role of the contact that the contract was
  • # originally sent to.
  • # signer_ip: The IP address of the contract signatory.
  • # signer_name: The name provided by the contract signatory.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • handwritten_signatures(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • contact_email_address: EmailAddress,
  • contact_name: String,
  • contact_role: String,
  • signer_ip: IP,
  • signer_name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): HandwrittenSignatureConnection!
  • # ICMP results.
  • #
  • # Arguments
  • # start_datetime: The date and time that this starts.
  • # end_datetime: The date and time that this ends.
  • # inventory_item_id: The ID of an `InventoryItem`.
  • icmp_results(
  • start_datetime: Datetime,
  • end_datetime: Datetime,
  • inventory_item_id: Int64Bit!
  • ): IcmpNetworkMonitoringResultConnection!
  • # Inbound mailboxes.
  • #
  • # 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.
  • # append_signature: Whether or not to append a signature.
  • # auto_reply: The auto reply to send.
  • # email_domain_id: The ID of an `EmailDomain`.
  • # enable_slack_integration: Whether or not to enable Slack
  • # integration.
  • # enabled: Whether or not this is enabled.
  • # from_mailbox: The mailbox email is sent from.
  • # from_name: The name to send from when using this email message.
  • # If `null`, then the system default will be used.
  • # inbound_mailbox: The inbound mailbox.
  • # name: A descriptive name.
  • # post_email_body_to_slack: Whether the email body should be
  • # posted to Slack, or just the email subject.
  • # priority: The priority of this item.
  • # send_auto_reply: Whether or not an auto reply should be sent.
  • # 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.
  • # slack_webhook_url: The URL of a Slack webhook. You can generate
  • # one at https://my.slack.com/services/new/incoming-webhook.
  • # ticket_group_id: The ID of a `TicketGroup`.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • inbound_mailboxes(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • append_signature: Boolean,
  • auto_reply: Text,
  • email_domain_id: Int64Bit,
  • enable_slack_integration: Boolean,
  • enabled: Boolean,
  • from_mailbox: String,
  • from_name: String,
  • inbound_mailbox: String,
  • name: String,
  • post_email_body_to_slack: Boolean,
  • priority: TicketPriority,
  • send_auto_reply: Boolean,
  • signature: Text,
  • slack_webhook_url: URL,
  • ticket_group_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): InboundMailboxConnection!
  • # Inline device credentials.
  • #
  • # 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.
  • # credential: An individual credential to authenticate to an
  • # inline device.
  • # inline_device_id: The ID of an `InlineDevice`.
  • # value: The credential value (e.g. username, password, etc.)
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • inline_device_credentials(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • credential: InlineDeviceAuthenticationCredential,
  • inline_device_id: Int64Bit,
  • value: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): InlineDeviceCredentialConnection!
  • # Inline devices.
  • #
  • # 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_subnets: Whether this device should write entries for all
  • # subnets or not.
  • # enabled: Whether or not this is enabled.
  • # ip_address: An IPv4/IPv6 address.
  • # last_synchronized: The date and time this device was last
  • # synchronized.
  • # name: A descriptive name.
  • # port: A TCP port.
  • # status: The status.
  • # status_message: A message describing what caused the current
  • # status of this device.
  • # synchronization_queued: Whether or not a synchronization
  • # request is queued.
  • # synchronization_start: The date/time that synchronization
  • # started.
  • # type: The type.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • inline_devices(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • all_subnets: Boolean,
  • enabled: Boolean,
  • ip_address: IP,
  • last_synchronized: Datetime,
  • name: String,
  • port: Port,
  • status: ProvisioningDeviceStatus,
  • status_message: String,
  • synchronization_queued: Boolean,
  • synchronization_start: Datetime,
  • type: InlineDeviceType,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): InlineDeviceConnection!
  • # Instance management requests.
  • #
  • # 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.
  • # authorization_valid_until: The date until which the
  • # authorization is valid.
  • # reason: The reason.
  • # responded_at: The date and time responded.
  • # responded_by_user_id: The id of the `User` that responded to
  • # the request.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • instance_management_requests(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • authorization_valid_until: Date,
  • reason: Text,
  • responded_at: Datetime,
  • responded_by_user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): InstanceManagementRequestConnection!
  • # Internal locations within an inventory location (e.g. a shelf or room.)
  • #
  • # 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.
  • # inventory_location_id: The ID of an `InventoryLocation`.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • internal_locations(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • inventory_location_id: Int64Bit,
  • name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): InternalLocationConnection!
  • # Inventory items.
  • #
  • # 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.
  • # 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_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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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,
  • metadata: String,
  • overall_status: InventoryItemDeviceStatus,
  • parent_inventory_item_id: Int64Bit,
  • preseem_status: PreseemStatus,
  • 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,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): InventoryItemConnection!
  • # Locations that inventory can be stored.
  • #
  • # 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.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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_locations(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • geopoint: Geopoint,
  • name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): InventoryLocationConnection!
  • # Categories of inventory.
  • #
  • # 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.
  • # icon: An icon.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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_model_categories(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • icon: Icon,
  • name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): InventoryModelCategoryConnection!
  • # Data stored on an inventory field (e.g. a MAC address or serial number.)
  • #
  • # 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.
  • # inventory_item_id: The ID of an `InventoryItem`.
  • # inventory_model_field_id: The ID of an `InventoryModelField`.
  • # value: The value.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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_model_field_data(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • inventory_item_id: Int64Bit,
  • inventory_model_field_id: Int64Bit,
  • value: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): InventoryModelFieldDataConnection!
  • # Fields that contain data about 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.
  • # inventory_model_id: The ID of an `InventoryModel`.
  • # name: A descriptive name.
  • # primary: A single inventory model field can be set to be the
  • # primary field. This will be used as the primary identifier for items of this
  • # model throughout Sonar.
  • # regexp: A PCRE regular expression. Omit the leading and closing
  • # /.
  • # required: Whether or not this field is required.
  • # secondary_type: Secondary types that inventory model fields can
  • # be set to.
  • # type: Types that inventory model fields can be set to.
  • # unique: Whether or not the field contents must be unique.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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_model_fields(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • inventory_model_id: Int64Bit,
  • name: String,
  • primary: Boolean,
  • regexp: String,
  • required: Boolean,
  • secondary_type: InventoryModelFieldSecondaryType,
  • type: InventoryModelFieldType,
  • unique: Uniqueness,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): InventoryModelFieldConnection!
  • # Inventory models.
  • #
  • # 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.
  • # device_type: The type of inventory model.
  • # enabled: Whether or not this is enabled.
  • # generic: Whether or not this is generic.
  • # icon: An icon.
  • # inventory_model_category_id: The ID of an
  • # InventoryModelCategory.
  • # lte_sim_type: If this is a SIM card for LTE provisioning, which
  • # provider this SIM is for.
  • # manufacturer_id: The ID of a Manufacturer.
  • # model_name: The actual model name/part number.
  • # name: A descriptive name.
  • # network_monitoring_template_id: The ID of a
  • # `NetworkMonitoringTemplate`.
  • # port: The TCP port that the web interface of this type of
  • # device is available on.
  • # protocol: The protocol used to access the web interface.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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_models(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • device_type: InventoryModelDeviceType,
  • enabled: Boolean,
  • generic: Boolean,
  • icon: Icon,
  • inventory_model_category_id: Int64Bit,
  • lte_sim_type: LteProviderType,
  • manufacturer_id: Int64Bit,
  • model_name: String,
  • name: String,
  • network_monitoring_template_id: Int64Bit,
  • port: Int,
  • protocol: Protocol,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): InventoryModelConnection!
  • # Invoice attachments.
  • #
  • # 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: The date to stop attaching this PDF to invoices.
  • # name: A descriptive name.
  • # start: The date to start attaching this PDF to invoices.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • invoice_attachments(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • end: Date,
  • name: String,
  • start: Date,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): InvoiceAttachmentConnection!
  • # Invoice messages.
  • #
  • # 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.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • invoice_messages(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • message: String,
  • name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): InvoiceMessageConnection!
  • # Invoices.
  • #
  • # 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.
  • # auto_pay_attempts: The number of times that auto pay has been
  • # attempted.
  • # auto_pay_date: The date that auto pay will be attempted.
  • # child_invoice_remaining_due: The sum of all due amounts on
  • # child invoices.
  • # company_id: The ID of the company that this entity operates
  • # under.
  • # date: A date
  • # delinquency_date: The date that this became delinquent.
  • # delinquent: Whether or not this entity is delinquent.
  • # due_date: The date this invoice is due by.
  • # end_date: The date that this ends.
  • # frozen: If an invoice is frozen, payments will not be
  • # automatically applied to it, and it cannot be modified.
  • # late_fee_applied: Whether or not a late fee has been applied.
  • # message: The message.
  • # number_of_months: The number of months of service this invoice
  • # was billed for.
  • # parent_invoice_id: The ID of the `Invoice` that is this
  • # `Invoice`s master.
  • # remaining_due: The amount remaining to be paid.
  • # total_debits: The sum of all debits that make up this invoice.
  • # total_taxes: The sum of all taxes on debits that make up this
  • # invoice.
  • # void: Whether or not this entity has been voided.
  • # voided_at: When this was voided.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • invoices(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • auto_pay_attempts: Int,
  • auto_pay_date: Date,
  • child_invoice_remaining_due: Int,
  • company_id: Int64Bit,
  • date: Date,
  • delinquency_date: Date,
  • delinquent: Boolean,
  • due_date: Date,
  • end_date: Date,
  • frozen: Boolean,
  • late_fee_applied: Boolean,
  • message: Text,
  • number_of_months: Int,
  • parent_invoice_id: Int64Bit,
  • remaining_due: Int,
  • total_debits: Int,
  • total_taxes: Int,
  • void: Boolean,
  • voided_at: Datetime,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): InvoiceConnection!
  • # IP assignment histories.
  • #
  • # 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.
  • # assigned_datetime: The date and time of assignment.
  • # description: A human readable description.
  • # ip_assignment_id: The ID of an `IpAssignment`.
  • # ipassignmentable_id: The ID of the owner of this
  • # `IpAssignment`.
  • # ipassignmentable_type: The owner of this `IpAssignment`.
  • # ipassignmenthistoryable_id: The ID of the entity that the IP
  • # address was assigned to.
  • # ipassignmenthistoryable_type: The parent entity that the IP
  • # address was assigned to (e.g. `Account`, `NetworkSite`.)
  • # reference: Some reference data regarding this IP assignment.
  • # removed_datetime: The date and time of removal.
  • # soft: If this IP was assigned automatically (e.g. via DHCP or
  • # RADIUS) then it will be marked as a soft assignment.
  • # subnet: An IPv4/IPv6 subnet.
  • # unique_identifier: Some unique identifier that was related to
  • # the IP (e.g. a MAC address, IMSI, RADIUS username.)
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • ip_assignment_histories(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • assigned_datetime: Datetime,
  • description: String,
  • ip_assignment_id: Int64Bit,
  • ipassignmentable_id: Int64Bit,
  • ipassignmentable_type: IpassignmentableType,
  • ipassignmenthistoryable_id: Int64Bit,
  • ipassignmenthistoryable_type: IpassignmenthistoryableType,
  • reference: Text,
  • removed_datetime: Datetime,
  • soft: Boolean,
  • subnet: SubnetScalar,
  • unique_identifier: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): IpAssignmentHistoryConnection!
  • # IP assignments.
  • #
  • # 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.
  • # description: A human readable description.
  • # ip_pool_id: The ID of an `IpPool`.
  • # ipassignmentable_id: The ID of the owner of this
  • # `IpAssignment`.
  • # ipassignmentable_type: The owner of this `IpAssignment`.
  • # reference: Some reference data regarding this IP assignment.
  • # soft: If this IP was assigned automatically (e.g. via DHCP or
  • # RADIUS) then it will be marked as a soft assignment.
  • # subnet: An IPv4/IPv6 subnet.
  • # subnet_id: The ID of a `Subnet`.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • ip_assignments(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • description: String,
  • ip_pool_id: Int64Bit,
  • ipassignmentable_id: Int64Bit,
  • ipassignmentable_type: IpassignmentableType,
  • reference: Text,
  • soft: Boolean,
  • subnet: SubnetScalar,
  • subnet_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): IpAssignmentConnection!
  • # IP pools.
  • #
  • # 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.
  • # dhcp_server_identifier_id: The ID of a `DhcpServerIdentifier`.
  • # ip_range: A range of IPv4 addresses.
  • # ips_available: The number of IP addresses available.
  • # name: A descriptive name.
  • # subnet_id: The ID of a `Subnet`.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • ip_pools(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • dhcp_server_identifier_id: Int64Bit,
  • ip_range: IpRange,
  • ips_available: Int,
  • name: String,
  • subnet_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): IpPoolConnection!
  • # Job available times.
  • #
  • # Arguments
  • # job_id: The ID of a `Job`.
  • # user_ids: IDs of `User`s.
  • # require_all_users: When true, find times where all `user_ids`
  • # are available. When `false`, find the availabilities for each individual user.
  • # start_datetime: The date and time that this starts.
  • # end_datetime: The date and time that this ends.
  • job_available_times(
  • job_id: Int64Bit!,
  • user_ids: [Int64Bit],
  • require_all_users: Boolean,
  • start_datetime: Datetime!,
  • end_datetime: Datetime!
  • ): [JobAvailableTimes]
  • # Job check ins.
  • #
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): JobCheckInConnection!
  • # Services associated with jobs.
  • #
  • # 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.
  • # job_id: The ID of a `Job`.
  • # quantity: The quantity for this service.
  • # service_id: The ID of a 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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_services(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • job_id: Int64Bit,
  • quantity: Int,
  • service_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): JobServiceConnection!
  • # Job types.
  • #
  • # 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_status_id_completion: If this is set, any `Job` using
  • # this `JobType` that is completed successfully while associated with an `Account`
  • # will change the `Account` to this `AccountStatus`.
  • # account_status_id_failure: If this is set, any `Job` using this
  • # `JobType` that is completed unsuccessfully while associated with an `Account`
  • # will change the `Account` to this `AccountStatus`.
  • # all_companies: Whether or not this `JobType` is valid for all
  • # `Companies`.
  • # allow_completion_with_incomplete_tasks: Whether `Job`s
  • # associated with this `JobType` should be able to be completed with incomplete
  • # tasks.
  • # color: Color.
  • # contract_template_id: The ID of a `ContractTemplate`.
  • # default_length_in_minutes: The default length for a `Job`
  • # created using this `JobType`.
  • # enabled: Whether or not this is enabled.
  • # icon: An icon.
  • # name: A descriptive name.
  • # task_template_id: The ID of a `TaskTemplate`.
  • # ticket_group_id_completion: If this is set, any `Job` using
  • # this `JobType` that is completed successfully will create a `Ticket` and assign
  • # it to this `TicketGroup`.
  • # ticket_group_id_failure: If this is set, any `Job` using this
  • # `JobType` that is completed unsuccessfully will create a `Ticket` and assign it
  • # to this `TicketGroup`.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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_types(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_status_id_completion: Int64Bit,
  • account_status_id_failure: Int64Bit,
  • all_companies: Boolean,
  • allow_completion_with_incomplete_tasks: Boolean,
  • color: HtmlHexColor,
  • contract_template_id: Int64Bit,
  • default_length_in_minutes: Int,
  • enabled: Boolean,
  • icon: Icon,
  • name: String,
  • task_template_id: Int64Bit,
  • ticket_group_id_completion: Int64Bit,
  • ticket_group_id_failure: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): JobTypeConnection!
  • # Jobs.
  • #
  • # 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.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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,
  • ticket_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): JobConnection!
  • # Local prefixes for voice services.
  • #
  • # 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.
  • # prefix: A telephone number prefix.
  • # voice_service_detail_id: The ID of the `VoiceServiceDetail`.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • local_prefixes(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • prefix: Numeric,
  • voice_service_detail_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): LocalPrefixConnection!
  • # Log entries for various events throughout Sonar.
  • #
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): LogConnection!
  • # Report builder licenses.
  • #
  • # 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.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • looker_explore_licenses(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): LookerExploreLicenseConnection!
  • # The credentials for an LTE provider.
  • #
  • # 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.
  • # credential: The credential name.
  • # lte_provider_id: The ID of an `LteProvider`.
  • # value: The value.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • lte_provider_credentials(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • credential: LteProviderAuthenticationCredential,
  • lte_provider_id: Int64Bit,
  • value: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): LteProviderCredentialConnection!
  • # LTE providers.
  • #
  • # 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.
  • # last_synchronized: The date and time this device was last
  • # synchronized.
  • # name: A descriptive name.
  • # status: The status.
  • # status_message: A message describing what caused the current
  • # status of this device.
  • # synchronization_queued: Whether or not a synchronization
  • # request is queued.
  • # synchronization_start: The date/time that synchronization
  • # started.
  • # type: The type.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • lte_providers(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • enabled: Boolean,
  • last_synchronized: Datetime,
  • name: String,
  • status: ProvisioningDeviceStatus,
  • status_message: String,
  • synchronization_queued: Boolean,
  • synchronization_start: Datetime,
  • type: LteProviderType,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): LteProviderConnection!
  • # Manufacturers.
  • #
  • # 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.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • manufacturers(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ManufacturerConnection!
  • # Mass email communications.
  • #
  • # 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.
  • # from_email_address: The email address to send from when using
  • # this email message. If `null`, then the system default will be used.
  • # from_name: The name to send from when using this email message.
  • # If `null`, then the system default will be used.
  • # message: The message.
  • # subject: The subject.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • mass_emails(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • from_email_address: EmailAddress,
  • from_name: String,
  • message: Text,
  • subject: String,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): MassEmailConnection!
  • # Get information about yourself!
  • me: Me!
  • # Logs of when billing ran successfully for an `Account`.
  • #
  • # 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.
  • # date: A date
  • # invoice_id: The ID of an `Invoice`.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • monthly_billing_completions(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • date: Date,
  • invoice_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): MonthlyBillingCompletionConnection!
  • # Get your IP address
  • my_ip_address: MyIpAddress!
  • # Netflow allowed subnets.
  • #
  • # 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.
  • # netflow_endpoint_id: The ID of a `NetflowEndpoint`.
  • # subnet: An IPv4/IPv6 subnet.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • netflow_allowed_subnets(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • netflow_endpoint_id: Int64Bit,
  • subnet: SubnetScalar,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): NetflowAllowedSubnetConnection!
  • # Netflow endpoints.
  • #
  • # 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.
  • # hostname: Hostname.
  • # name: A descriptive name.
  • # port: A TCP port.
  • # whitelist_mode: Whitelist mode.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • netflow_endpoints(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • hostname: DomainName,
  • name: String,
  • port: Port,
  • whitelist_mode: Boolean,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): NetflowEndpointConnection!
  • # Netflow whitelists.
  • #
  • # 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.
  • # netflow_endpoint_id: The ID of a `NetflowEndpoint`.
  • # subnet: An IPv4/IPv6 subnet.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • netflow_whitelists(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • netflow_endpoint_id: Int64Bit,
  • subnet: SubnetScalar,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): NetflowWhitelistConnection!
  • # Network monitoring graphs.
  • #
  • # 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.
  • # name: A descriptive name.
  • # network_monitoring_template_id: The ID of a
  • # `NetworkMonitoringTemplate`.
  • # stacked: Stacked
  • # type: The type.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • network_monitoring_graphs(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • name: String,
  • network_monitoring_template_id: Int64Bit,
  • stacked: Boolean,
  • type: NetworkMonitoringGraphType,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): NetworkMonitoringGraphConnection!
  • # Network monitoring templates.
  • #
  • # 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.
  • # collect_interface_statistics: Whether or not to collect
  • # interface statistics.
  • # icmp_latency_threshold: ICMP latency threshold (ms).
  • # icmp_loss_threshold: ICMP loss threshold (%).
  • # icmp_monitoring: Whether or not ICMP monitoring is enabled.
  • # name: A descriptive name.
  • # snmp3_auth_passphrase: SNMPv3 auth passphrase
  • # snmp3_auth_protocol: SNMPv3 auth protocol
  • # snmp3_context_engineid: SNMPv3 context engine ID
  • # snmp3_context_name: SNMPv3 context name
  • # snmp3_priv_passphrase: SNMPv3 privacy passphrase
  • # snmp3_priv_protocol: SNMPv3 privacy protocol
  • # snmp3_sec_level: SNMPv3 security level
  • # snmp_community: SNMP community/securityName
  • # snmp_version: SNMP version
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • network_monitoring_templates(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • collect_interface_statistics: Boolean,
  • icmp_latency_threshold: Int,
  • icmp_loss_threshold: Int,
  • icmp_monitoring: Boolean,
  • name: String,
  • snmp3_auth_passphrase: Text,
  • snmp3_auth_protocol: Snmp3AuthProtocol,
  • snmp3_context_engineid: Text,
  • snmp3_context_name: Text,
  • snmp3_priv_passphrase: Text,
  • snmp3_priv_protocol: Snmp3PrivProtocol,
  • snmp3_sec_level: Snmp3SecurityLevel,
  • snmp_community: Text,
  • snmp_version: SnmpVersion,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): NetworkMonitoringTemplateConnection!
  • # Network sites.
  • #
  • # 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.
  • # height_in_meters: Height in meters.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • network_sites(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • geopoint: Geopoint,
  • height_in_meters: Float,
  • name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): NetworkSiteConnection!
  • # Notes.
  • #
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): NoteConnection!
  • # Details related to an overage service.
  • #
  • # 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.
  • # gigabytes: A value in gigabytes.
  • # service_id: The ID of a 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • overage_service_details(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • gigabytes: Int,
  • service_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): OverageServiceDetailConnection!
  • # Services associated with a package.
  • #
  • # 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.
  • # package_id: The ID of a `Package`.
  • # quantity: The quantity for this service.
  • # service_id: The ID of a 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • package_services(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • package_id: Int64Bit,
  • quantity: Int,
  • service_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): PackageServiceConnection!
  • # Packages.
  • #
  • # 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.
  • # company_id: The ID of the company that this entity operates
  • # under.
  • # enabled: Whether or not this is enabled.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • packages(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • company_id: Int64Bit,
  • enabled: Boolean,
  • name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): PackageConnection!
  • # The password policy for users.
  • password_policy: PasswordPolicy!
  • # Payments.
  • #
  • # 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 payment, in the smallest currency
  • # value.
  • # amount_remaining: The amount remaining that can be used.
  • # bank_account_id: The ID of a BankAccount.
  • # company_id: The ID of the company that this entity operates
  • # under.
  • # credit_card_id: The ID of a CreditCard.
  • # deposit_slip_id: The deposit slip ID.
  • # description: A description of the payment, used for internal
  • # reference.
  • # full_processor_response: The entire response back from the
  • # company that processed the transaction. Not typically human readable.
  • # payment_datetime: The date and time the payment was made.
  • # payment_tracker_id: The unique tracking ID for this payment.
  • # payment_type: The type of payment (e.g. cash, credit card.)
  • # processor_message: The message returned back from the company
  • # that processed the transaction.
  • # reference: A payment reference like a check number, or wire
  • # transfer confirmation number.
  • # successful: Whether or not this was successful.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • payments(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • amount: Int,
  • amount_remaining: Int,
  • bank_account_id: Int64Bit,
  • company_id: Int64Bit,
  • credit_card_id: Int64Bit,
  • deposit_slip_id: Int64Bit,
  • description: String,
  • full_processor_response: String,
  • payment_datetime: Datetime,
  • payment_tracker_id: String,
  • payment_type: PaymentType,
  • processor_message: String,
  • reference: String,
  • successful: Boolean,
  • transaction_id: String,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): PaymentConnection!
  • # Your personal access tokens.
  • personal_access_tokens: PersonalAccessTokenConnection!
  • # Types of phone numbers (e.g. mobile, home, fax.)
  • #
  • # 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.
  • # name: A descriptive name.
  • # sms_capable: Whether or not phone numbers of this type are
  • # capable of sending and receiving SMS messages.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • phone_number_types(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • name: String,
  • sms_capable: Boolean,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): PhoneNumberTypeConnection!
  • # Phone numbers.
  • #
  • # 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.
  • # contact_id: The ID of the contact that owns this.
  • # country: A two character country code for this phone number.
  • # extension: The extension.
  • # number: The number.
  • # number_formatted: A phone number formatted for human
  • # readability.
  • # phone_number_type_id: The ID of the PhoneNumberType associated
  • # with this phone number.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.