Class MessagingServiceScansService

Hierarchy

  • MessagingServiceScansService

Constructors

constructor

Methods

deleteMessagingServiceScan getMessagingServiceScan getMessagingServiceScans

Constructors

constructor

Methods

Static deleteMessagingServiceScan

  • Delete a messaging service scan Use this API to delete a messaging service scan.

    Token Permissions: [ messaging_service_scan:write ]

    Returns

    void

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          id: string;
          xContextId?: string;
      }
      • id: string

        The ID of the messaging service scan. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<void>

Static getMessagingServiceScan

  • Get a messaging service scan Use this API to get a single messaging service scan by its ID.

    Token Permissions: [ messaging_service_scan:read ]

    Returns

    MessagingServiceScanResponse The messaging service scan.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          id: string;
          xContextId?: string;
      }
      • id: string

        The ID of the messaging service scan. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MessagingServiceScanResponse>

Static getMessagingServiceScans

  • Get a list of messaging service scans Use this API to get a list of messaging service scans that match the given parameters.

    Token Permissions: [ messaging_service_scan:read ]

    Returns

    MessagingServiceScansResponse The list of messaging service scans and the accompanying metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          eventMeshId?: string;
          ids?: string[];
          messagingServiceId?: string;
          pageNumber?: number;
          pageSize?: number;
          sort?: string;
          xContextId?: string;
      }
      • Optional eventMeshId?: string

        Match only messaging service scans in the given eventMeshId *

      • Optional ids?: string[]

        The IDs of the messaging service scans. *

      • Optional messagingServiceId?: string

        Match only messaging service scans in the given messagingService *

      • Optional pageNumber?: number

        The page number to get. *

      • Optional pageSize?: number

        The number of messaging service scans to get per page. *

      • Optional sort?: string

        Sort based on the provided parameters.
        The value can be either a standalone field name (?sort=<field>) or a field and direction, delimited by a colon (?sort=<field>:<asc|desc>). If the direction is not specified, the default is ascending. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MessagingServiceScansResponse>

Settings

Member Visibility

Theme