Interface CustomerGroup

All Superinterfaces:
BaseResource, CustomerGroupMixin, Customizable<CustomerGroup>, DomainResource<CustomerGroup>, Identifiable<CustomerGroup>, Referencable<CustomerGroup>, ResourceIdentifiable<CustomerGroup>, Versioned<CustomerGroup>, WithKey

CustomerGroup
Example to create an instance using the builder pattern

     CustomerGroup customerGroup = CustomerGroup.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .name("{name}")
             .build()
 
  • Method Details

    • getId

      @NotNull @NotNull String getId()

      Unique identifier of the CustomerGroup.

      Specified by:
      getId in interface BaseResource
      Specified by:
      getId in interface DomainResource<CustomerGroup>
      Specified by:
      getId in interface Identifiable<CustomerGroup>
      Specified by:
      getId in interface Versioned<CustomerGroup>
      Returns:
      id
    • getVersion

      @NotNull @NotNull Long getVersion()

      Current version of the CustomerGroup.

      Specified by:
      getVersion in interface BaseResource
      Specified by:
      getVersion in interface DomainResource<CustomerGroup>
      Specified by:
      getVersion in interface Versioned<CustomerGroup>
      Returns:
      version
    • getCreatedAt

      @NotNull @NotNull ZonedDateTime getCreatedAt()

      Date and time (UTC) the CustomerGroup was initially created.

      Specified by:
      getCreatedAt in interface BaseResource
      Returns:
      createdAt
    • getLastModifiedAt

      @NotNull @NotNull ZonedDateTime getLastModifiedAt()

      Date and time (UTC) the CustomerGroup was last updated.

      Specified by:
      getLastModifiedAt in interface BaseResource
      Returns:
      lastModifiedAt
    • getLastModifiedBy

      @Valid @Valid LastModifiedBy getLastModifiedBy()

      Present on resources updated after 1 February 2019 except for events not tracked.

      Returns:
      lastModifiedBy
    • getCreatedBy

      @Valid @Valid CreatedBy getCreatedBy()

      Present on resources created after 1 February 2019 except for events not tracked.

      Returns:
      createdBy
    • getKey

      String getKey()

      User-defined unique identifier for the CustomerGroup.

      Specified by:
      getKey in interface WithKey
      Returns:
      key
    • getName

      @NotNull @NotNull String getName()

      Unique name of the CustomerGroup.

      Returns:
      name
    • getCustom

      @Valid @Valid CustomFields getCustom()

      Custom Fields for the CustomerGroup.

      Specified by:
      getCustom in interface Customizable<CustomerGroup>
      Returns:
      custom
    • setId

      void setId(String id)

      Unique identifier of the CustomerGroup.

      Specified by:
      setId in interface BaseResource
      Parameters:
      id - value to be set
    • setVersion

      void setVersion(Long version)

      Current version of the CustomerGroup.

      Specified by:
      setVersion in interface BaseResource
      Parameters:
      version - value to be set
    • setCreatedAt

      void setCreatedAt(ZonedDateTime createdAt)

      Date and time (UTC) the CustomerGroup was initially created.

      Specified by:
      setCreatedAt in interface BaseResource
      Parameters:
      createdAt - value to be set
    • setLastModifiedAt

      void setLastModifiedAt(ZonedDateTime lastModifiedAt)

      Date and time (UTC) the CustomerGroup was last updated.

      Specified by:
      setLastModifiedAt in interface BaseResource
      Parameters:
      lastModifiedAt - value to be set
    • setLastModifiedBy

      void setLastModifiedBy(LastModifiedBy lastModifiedBy)

      Present on resources updated after 1 February 2019 except for events not tracked.

      Parameters:
      lastModifiedBy - value to be set
    • setCreatedBy

      void setCreatedBy(CreatedBy createdBy)

      Present on resources created after 1 February 2019 except for events not tracked.

      Parameters:
      createdBy - value to be set
    • setKey

      void setKey(String key)

      User-defined unique identifier for the CustomerGroup.

      Parameters:
      key - value to be set
    • setName

      void setName(String name)

      Unique name of the CustomerGroup.

      Parameters:
      name - value to be set
    • setCustom

      void setCustom(CustomFields custom)

      Custom Fields for the CustomerGroup.

      Specified by:
      setCustom in interface Customizable<CustomerGroup>
      Parameters:
      custom - value to be set
    • of

      static CustomerGroup of()
      factory method
      Returns:
      instance of CustomerGroup
    • of

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

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

      static CustomerGroupBuilder builder()
      builder factory method for CustomerGroup
      Returns:
      builder
    • builder

      static CustomerGroupBuilder builder(CustomerGroup template)
      create builder for CustomerGroup instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder
    • withCustomerGroup

      default <T> T withCustomerGroup(Function<CustomerGroup,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value
    • referenceTypeId

      static ReferenceTypeId referenceTypeId()
    • typeReference

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