com.tryfinch.api.models.BenefitFrequency.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of finch-java-core Show documentation

The Finch HRIS API provides a unified way to connect to a multitide of HRIS systems. The API requires an access token issued by Finch. By default, Organization and Payroll requests use Finch's [Data Syncs](/developer-resources/Data-Syncs). If a request is made before the initial sync has completed, Finch will request data live from the provider. The latency on live requests may range from seconds to minutes depending on the provider and batch size. For automated integrations, Deductions requests (both read and write) are always made live to the provider. Latencies may range from seconds to minutes depending on the provider and batch size. Employer products are specified by the product parameter, a space-separated list of products that your application requests from an employer authenticating through Finch Connect. Valid product names are— - `company`: Read basic company data - `directory`: Read company directory and organization structure - `individual`: Read individual data, excluding income and employment data - `employment`: Read individual employment and income data - `payment`: Read payroll and contractor related payments by the company - `pay_statement`: Read detailed pay statements for each individual - `benefits`: Create and manage deductions and contributions and enrollment for an employer [![Open in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/21027137-08db0929-883d-4094-a9ce-dbf5a9bee4a4?action=collection%2Ffork&collection-url=entityId%3D21027137-08db0929-883d-4094-a9ce-dbf5a9bee4a4%26entityType%3Dcollection%26workspaceId%3D1edf19bc-e0a8-41e9-ac55-481a4b50790b)

There is a newer version: 1.11.0

Show newest version

// File generated from our OpenAPI spec by Stainless.

package com.tryfinch.api.models

import com.fasterxml.jackson.annotation.JsonCreator
import com.tryfinch.api.core.Enum
import com.tryfinch.api.core.JsonField
import com.tryfinch.api.core.JsonValue
import com.tryfinch.api.errors.FinchInvalidDataException

class BenefitFrequency
@JsonCreator
private constructor(
    private val value: JsonField,
) : Enum {

    @com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField = value

    override fun equals(other: Any?): Boolean {
        if (this === other) {
            return true
        }

        return other is BenefitFrequency && this.value == other.value
    }

    override fun hashCode() = value.hashCode()

    override fun toString() = value.toString()

    companion object {

        @JvmField val ONE_TIME = BenefitFrequency(JsonField.of("one_time"))

        @JvmField val EVERY_PAYCHECK = BenefitFrequency(JsonField.of("every_paycheck"))

        @JvmField val MONTHLY = BenefitFrequency(JsonField.of("monthly"))

        @JvmStatic fun of(value: String) = BenefitFrequency(JsonField.of(value))
    }

    enum class Known {
        ONE_TIME,
        EVERY_PAYCHECK,
        MONTHLY,
    }

    enum class Value {
        ONE_TIME,
        EVERY_PAYCHECK,
        MONTHLY,
        _UNKNOWN,
    }

    fun value(): Value =
        when (this) {
            ONE_TIME -> Value.ONE_TIME
            EVERY_PAYCHECK -> Value.EVERY_PAYCHECK
            MONTHLY -> Value.MONTHLY
            else -> Value._UNKNOWN
        }

    fun known(): Known =
        when (this) {
            ONE_TIME -> Known.ONE_TIME
            EVERY_PAYCHECK -> Known.EVERY_PAYCHECK
            MONTHLY -> Known.MONTHLY
            else -> throw FinchInvalidDataException("Unknown BenefitFrequency: $value")
        }

    fun asString(): String = _value().asStringOrThrow()
}