Package ai.vectros.types

Class OrgRequest.Builder

java.lang.Object
ai.vectros.types.OrgRequest.Builder
All Implemented Interfaces:
OrgRequest._FinalStage, OrgRequest.ExternalIdStage
Enclosing class:
OrgRequest
public static final class OrgRequest.Builder extends Object implements OrgRequest.ExternalIdStage, OrgRequest._FinalStage

  • Method Details

    • from

      public OrgRequest.Builder from(OrgRequest other)
      Specified by:
      from in interface OrgRequest.ExternalIdStage

    • externalId

      public OrgRequest._FinalStage externalId(@NotNull @NotNull String externalId)

      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.

      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.

      Specified by:
      externalId in interface OrgRequest.ExternalIdStage
      Returns:
      Reference to this so that method calls can be chained together.

    • schemaId

      public OrgRequest._FinalStage schemaId(String schemaId)

      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.

      Specified by:
      schemaId in interface OrgRequest._FinalStage
      Returns:
      Reference to this so that method calls can be chained together.

    • schemaId

      public OrgRequest._FinalStage schemaId(Optional<String> schemaId)

      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.

      Specified by:
      schemaId in interface OrgRequest._FinalStage

    • payload

      public OrgRequest._FinalStage payload(Map<String,Object> payload)

      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.

      Specified by:
      payload in interface OrgRequest._FinalStage
      Returns:
      Reference to this so that method calls can be chained together.

    • payload

      public OrgRequest._FinalStage payload(Optional<Map<String,Object>> payload)

      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.

      Specified by:
      payload in interface OrgRequest._FinalStage

    • status

      public OrgRequest._FinalStage status(OrgRequestStatus status)

      Lifecycle status of the organization. ACTIVE organizations can be used normally; SUSPENDED organizations are retained but blocked from new operations.

      Specified by:
      status in interface OrgRequest._FinalStage
      Returns:
      Reference to this so that method calls can be chained together.

    • status

      public OrgRequest._FinalStage status(Optional<OrgRequestStatus> status)

      Lifecycle status of the organization. ACTIVE organizations can be used normally; SUSPENDED organizations are retained but blocked from new operations.

      Specified by:
      status in interface OrgRequest._FinalStage

    • name

      public OrgRequest._FinalStage name(String name)

      Human-readable name for the organization.

      Specified by:
      name in interface OrgRequest._FinalStage
      Returns:
      Reference to this so that method calls can be chained together.

    • name

      public OrgRequest._FinalStage name(Optional<String> name)

      Human-readable name for the organization.

      Specified by:
      name in interface OrgRequest._FinalStage

    • build

      public OrgRequest build()
      Specified by:
      build in interface OrgRequest._FinalStage

    • additionalProperty

      public OrgRequest.Builder additionalProperty(String key, Object value)
      Specified by:
      additionalProperty in interface OrgRequest._FinalStage

    • additionalProperties

      public OrgRequest.Builder additionalProperties(Map<String,Object> additionalProperties)
      Specified by:
      additionalProperties in interface OrgRequest._FinalStage