commonMain.city.smartb.im.organization.domain.features.query.OrganizationGetFromInseeFunction.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of organization-domain Show documentation

Identity Management

There is a newer version: 0.14.2

package city.smartb.im.organization.domain.features.query

import city.smartb.im.organization.domain.model.Organization
import city.smartb.im.organization.domain.model.OrganizationDTO
import f2.dsl.cqrs.Event
import f2.dsl.cqrs.Query
import f2.dsl.fnc.F2Function
import kotlin.js.JsExport
import kotlin.js.JsName

/**
 * Get an organization by Siret from the Insee Sirene API.
 * @d2 function
 * @parent [city.smartb.im.organization.domain.D2OrganizationPage]
 * @order 20
 */
typealias OrganizationGetFromInseeFunction =
        F2Function

@JsExport
@JsName("OrganizationGetFromInseeQueryDTO")
interface OrganizationGetFromInseeQueryDTO: Query {
    val siret: String
}

/**
 * @d2 query
 * @parent [OrganizationGetFromInseeFunction]
 */
data class OrganizationGetFromInseeQuery(
    /**
     * Siret number of the organization.
     * @example [city.smartb.im.organization.domain.model.Organization.siret]
     */
    override val siret: String
): OrganizationGetFromInseeQueryDTO

@JsExport
@JsName("OrganizationGetFromInseeResultDTO")
interface OrganizationGetFromInseeResultDTO: Event {
    val item: OrganizationDTO?
}

/**
 * @d2 result
 * @parent [OrganizationGetFromInseeFunction]
 */
data class OrganizationGetFromInseeResult(
    /**
     * The organization.
     */
    override val item: Organization?
): OrganizationGetFromInseeResultDTO