Package com.commercetools.api.models.agent

Interface AgentResponsesPayload

public interface AgentResponsesPayload

Structured fields for the payload part of a multipart/form-data /responses request to the Intake Agent. prompt is optional when files are attached.

For an application/json request, use AgentResponsesRequest instead.

Example to create an instance using the builder pattern 

     AgentResponsesPayload agentResponsesPayload = AgentResponsesPayload.builder()
             .outputType(AgentResponsesOutputType.CART)
             .locale("{locale}")
             .build()

  • Method Details

    • getOutputType

      @NotNull @NotNull AgentResponsesOutputType getOutputType()

      The entity to create.

      Returns:
      outputType

    • getLocale

      @NotNull @NotNull String getLocale()

      A valid BCP 47 language tag, for example en-US.

      Returns:
      locale

    • getPrompt

      String getPrompt()

      Natural-language description of the desired Cart or Quote Request, such as the body of an email or a note. Required if no file is attached.

      Returns:
      prompt

    • getBusinessUnit

      @Valid @Valid BusinessUnitResourceIdentifier getBusinessUnit()

      BusinessUnit to use for the request. If omitted, the Intake Agent resolves it from the input.

      Returns:
      businessUnit

    • getStore

      @Valid @Valid StoreResourceIdentifier getStore()

      Store to use for the request. If omitted, the Intake Agent resolves it from the input.

      Returns:
      store

    • setOutputType

      void setOutputType(AgentResponsesOutputType outputType)

      The entity to create.

      Parameters:
      outputType - value to be set

    • setLocale

      void setLocale(String locale)

      A valid BCP 47 language tag, for example en-US.

      Parameters:
      locale - value to be set

    • setPrompt

      void setPrompt(String prompt)

      Natural-language description of the desired Cart or Quote Request, such as the body of an email or a note. Required if no file is attached.

      Parameters:
      prompt - value to be set

    • setBusinessUnit

      void setBusinessUnit(BusinessUnitResourceIdentifier businessUnit)

      BusinessUnit to use for the request. If omitted, the Intake Agent resolves it from the input.

      Parameters:
      businessUnit - value to be set

    • setStore

      void setStore(StoreResourceIdentifier store)

      Store to use for the request. If omitted, the Intake Agent resolves it from the input.

      Parameters:
      store - value to be set

    • of

      static AgentResponsesPayload of()
      factory method
      Returns:
      instance of AgentResponsesPayload

    • of

      static AgentResponsesPayload of(AgentResponsesPayload template)
      factory method to create a shallow copy AgentResponsesPayload
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      AgentResponsesPayload copyDeep()

    • deepCopy

      @Nullable static AgentResponsesPayload deepCopy(@Nullable AgentResponsesPayload template)
      factory method to create a deep copy of AgentResponsesPayload
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static AgentResponsesPayloadBuilder builder()
      builder factory method for AgentResponsesPayload
      Returns:
      builder

    • builder

      static AgentResponsesPayloadBuilder builder(AgentResponsesPayload template)
      create builder for AgentResponsesPayload instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withAgentResponsesPayload

      default <T> T withAgentResponsesPayload(Function<AgentResponsesPayload,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static tools.jackson.core.type.TypeReference<AgentResponsesPayload> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference