com.squareup.square.legacy.models.ShiftWorkday Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of square-legacy Show documentation
There is a newer version: 44.2.0.20250521
package com.squareup.square.legacy.models;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonGetter;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import io.apimatic.core.types.OptionalNullable;
import java.util.Objects;

/**
 * This is a model class for ShiftWorkday type.
 */
public class ShiftWorkday {
    private final DateRange dateRange;
    private final String matchShiftsBy;
    private final OptionalNullable defaultTimezone;

    /**
     * Initialization constructor.
     * @param  dateRange  DateRange value for dateRange.
     * @param  matchShiftsBy  String value for matchShiftsBy.
     * @param  defaultTimezone  String value for defaultTimezone.
     */
    @JsonCreator
    public ShiftWorkday(
            @JsonProperty("date_range") DateRange dateRange,
            @JsonProperty("match_shifts_by") String matchShiftsBy,
            @JsonProperty("default_timezone") String defaultTimezone) {
        this.dateRange = dateRange;
        this.matchShiftsBy = matchShiftsBy;
        this.defaultTimezone = OptionalNullable.of(defaultTimezone);
    }

    /**
     * Initialization constructor.
     * @param  dateRange  DateRange value for dateRange.
     * @param  matchShiftsBy  String value for matchShiftsBy.
     * @param  defaultTimezone  String value for defaultTimezone.
     */
    protected ShiftWorkday(DateRange dateRange, String matchShiftsBy, OptionalNullable defaultTimezone) {
        this.dateRange = dateRange;
        this.matchShiftsBy = matchShiftsBy;
        this.defaultTimezone = defaultTimezone;
    }

    /**
     * Getter for DateRange.
     * A range defined by two dates. Used for filtering a query for Connect v2 objects that have
     * date properties.
     * @return Returns the DateRange
     */
    @JsonGetter("date_range")
    @JsonInclude(JsonInclude.Include.NON_NULL)
    public DateRange getDateRange() {
        return dateRange;
    }

    /**
     * Getter for MatchShiftsBy.
     * Defines the logic used to apply a workday filter.
     * @return Returns the String
     */
    @JsonGetter("match_shifts_by")
    @JsonInclude(JsonInclude.Include.NON_NULL)
    public String getMatchShiftsBy() {
        return matchShiftsBy;
    }

    /**
     * Internal Getter for DefaultTimezone.
     * Location-specific timezones convert workdays to datetime filters. Every location included in
     * the query must have a timezone or this field must be provided as a fallback. Format: the IANA
     * timezone database identifier for the relevant timezone.
     * @return Returns the Internal String
     */
    @JsonGetter("default_timezone")
    @JsonInclude(JsonInclude.Include.NON_NULL)
    @JsonSerialize(using = OptionalNullable.Serializer.class)
    protected OptionalNullable internalGetDefaultTimezone() {
        return this.defaultTimezone;
    }

    /**
     * Getter for DefaultTimezone.
     * Location-specific timezones convert workdays to datetime filters. Every location included in
     * the query must have a timezone or this field must be provided as a fallback. Format: the IANA
     * timezone database identifier for the relevant timezone.
     * @return Returns the String
     */
    @JsonIgnore
    public String getDefaultTimezone() {
        return OptionalNullable.getFrom(defaultTimezone);
    }

    @Override
    public int hashCode() {
        return Objects.hash(dateRange, matchShiftsBy, defaultTimezone);
    }

    @Override
    public boolean equals(Object obj) {
        if (obj == this) {
            return true;
        }
        if (!(obj instanceof ShiftWorkday)) {
            return false;
        }
        ShiftWorkday other = (ShiftWorkday) obj;
        return Objects.equals(dateRange, other.dateRange)
                && Objects.equals(matchShiftsBy, other.matchShiftsBy)
                && Objects.equals(defaultTimezone, other.defaultTimezone);
    }

    /**
     * Converts this ShiftWorkday into string format.
     * @return String representation of this class
     */
    @Override
    public String toString() {
        return "ShiftWorkday [" + "dateRange=" + dateRange + ", matchShiftsBy=" + matchShiftsBy + ", defaultTimezone="
                + defaultTimezone + "]";
    }

    /**
     * Builds a new {@link ShiftWorkday.Builder} object.
     * Creates the instance with the state of the current model.
     * @return a new {@link ShiftWorkday.Builder} object
     */
    public Builder toBuilder() {
        Builder builder = new Builder().dateRange(getDateRange()).matchShiftsBy(getMatchShiftsBy());
        builder.defaultTimezone = internalGetDefaultTimezone();
        return builder;
    }

    /**
     * Class to build instances of {@link ShiftWorkday}.
     */
    public static class Builder {
        private DateRange dateRange;
        private String matchShiftsBy;
        private OptionalNullable defaultTimezone;

        /**
         * Setter for dateRange.
         * @param  dateRange  DateRange value for dateRange.
         * @return Builder
         */
        public Builder dateRange(DateRange dateRange) {
            this.dateRange = dateRange;
            return this;
        }

        /**
         * Setter for matchShiftsBy.
         * @param  matchShiftsBy  String value for matchShiftsBy.
         * @return Builder
         */
        public Builder matchShiftsBy(String matchShiftsBy) {
            this.matchShiftsBy = matchShiftsBy;
            return this;
        }

        /**
         * Setter for defaultTimezone.
         * @param  defaultTimezone  String value for defaultTimezone.
         * @return Builder
         */
        public Builder defaultTimezone(String defaultTimezone) {
            this.defaultTimezone = OptionalNullable.of(defaultTimezone);
            return this;
        }

        /**
         * UnSetter for defaultTimezone.
         * @return Builder
         */
        public Builder unsetDefaultTimezone() {
            defaultTimezone = null;
            return this;
        }

        /**
         * Builds a new {@link ShiftWorkday} object using the set fields.
         * @return {@link ShiftWorkday}
         */
        public ShiftWorkday build() {
            return new ShiftWorkday(dateRange, matchShiftsBy, defaultTimezone);
        }
    }
}