Interface SmartHandsRequests

All Known Implementing Classes:
SmartHandsRequestsImpl
public interface SmartHandsRequests
Client interface for submitting Smart Hands orders in the Equinix Customer Portal.

Backed by the Smart Hands v1 API at /v1/orders/smarthands/{type}. Each Smart Hands service has its own typed create operation; all share the common request envelope (SmartHandsRequestJson: IBX location, contacts, schedule, optional purchase order and attachments) plus a per-type serviceDetails object. A typed serviceDetails creator exists for every order type (e.g. EquipmentInstallDetails, RunJumperCableDetails); a free-form Map<String, Object> remains available as an escape hatch. Reference data is available via listLocations() and listTypes().

  • Method Details

    • createEquipmentInstall

      SmartHandResponse createEquipmentInstall(SmartHandsRequestJson request)
      Requests equipment installation per your specifications by an IBX technician.
      Parameters:
      request - the smart hands request body
      Returns:
      the created order response

    • createShipmentUnpack

      SmartHandResponse createShipmentUnpack(SmartHandsRequestJson request)
      Requests inbound shipment unpacking and packaging disposal.
      Parameters:
      request - the smart hands request body
      Returns:
      the created order response

    • createMoveJumperCable

      SmartHandResponse createMoveJumperCable(SmartHandsRequestJson request)
      Requests a jumper cable to be moved.
      Parameters:
      request - the smart hands request body
      Returns:
      the created order response

    • createCageEscort

      SmartHandResponse createCageEscort(SmartHandsRequestJson request)
      Requests an escort into a cage.
      Parameters:
      request - the smart hands request body
      Returns:
      the created order response

    • createLocatePackage

      SmartHandResponse createLocatePackage(SmartHandsRequestJson request)
      Requests a package to be located.
      Parameters:
      request - the smart hands request body
      Returns:
      the created order response

    • createPicturesDocument

      SmartHandResponse createPicturesDocument(SmartHandsRequestJson request)
      Requests pictures or documentation of equipment.
      Parameters:
      request - the smart hands request body
      Returns:
      the created order response

    • createPatchCableInstall

      SmartHandResponse createPatchCableInstall(SmartHandsRequestJson request)
      Requests a patch cable to be installed.
      Parameters:
      request - the smart hands request body
      Returns:
      the created order response

    • createPatchCableRemoval

      SmartHandResponse createPatchCableRemoval(SmartHandsRequestJson request)
      Requests a patch cable to be removed.
      Parameters:
      request - the smart hands request body
      Returns:
      the created order response

    • createCageCleanup

      SmartHandResponse createCageCleanup(SmartHandsRequestJson request)
      Requests a cage cleanup.
      Parameters:
      request - the smart hands request body
      Returns:
      the created order response

    • createCableRequest

      SmartHandResponse createCableRequest(SmartHandsRequestJson request)
      Requests a cable.
      Parameters:
      request - the smart hands request body
      Returns:
      the created order response

    • createRunJumperCable

      SmartHandResponse createRunJumperCable(SmartHandsRequestJson request)
      Requests a jumper cable to be run.
      Parameters:
      request - the smart hands request body
      Returns:
      the created order response

    • createOther

      SmartHandResponse createOther(SmartHandsRequestJson request)
      Requests another smart hands service not covered by a dedicated type.
      Parameters:
      request - the smart hands request body
      Returns:
      the created order response

    • listLocations

      List<? extends SmartHandsLocation> listLocations()
      Lists the IBX locations, cages and cabinets where the current user may place smart hands orders.
      Returns:
      the list of permitted locations

    • listLocations

      List<? extends SmartHandsLocation> listLocations(Boolean detail, String ibxs, String cages)
      Lists the IBX locations, cages and cabinets where the current user may place smart hands orders, optionally filtered.

      Maps to GET /v1/orders/smarthands/locations (getLocation).

      Parameters:
      detail - when true, returns detailed permission with cages and cabinets, or null for the default
      ibxs - a comma-separated list of IBX codes to filter by (e.g. AM1,AM2), or null
      cages - a comma-separated list of cage ids to filter by (e.g. AM1:02:002MC1), or null
      Returns:
      the list of permitted locations

    • listTypes

      List<? extends SmartHandType> listTypes()
      Lists all supported smart hands order types.
      Returns:
      the list of supported types