Package ai.vectros.types

Class OrgRequest

java.lang.Object
ai.vectros.types.OrgRequest
public final class OrgRequest extends Object

  • Method Details

    • getExternalId

      public String getExternalId()
      Returns:
      Your own unique identifier for this organization. Used for idempotent upsert: if an organization with this externalId already exists, it is returned instead of creating a duplicate.

    • getName

      public Optional<String> getName()
      Returns:
      Human-readable name for the organization.

    • getStatus

      public Optional<OrgRequestStatus> getStatus()
      Returns:
      Lifecycle status of the organization. ACTIVE organizations can be used normally; SUSPENDED organizations are retained but blocked from new operations.

    • getPayload

      public Optional<Map<String,Object>> getPayload()
      Returns:
      Free-form key-value attributes to store with the organization — use it to attach additional data from your own system. On update, the supplied object replaces the stored payload in full (it is not key-merged); omit it to leave the stored payload unchanged.

    • getSchemaId

      public Optional<String> getSchemaId()
      Returns:
      Optional ID of a record schema (created via POST /v1/schemas) that governs payload validation and lookup indexing for this organization, and must belong to your account. When set, the payload is validated against the schema on save and the schema's declared lookup fields become queryable via GET /v1/orgs?type=...&field=...&value=...; when omitted, the payload is free-form and no lookup fields are indexed. Once set, this reference cannot currently be cleared.

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • builder

      public static OrgRequest.ExternalIdStage builder()