@nht-pandats/sdk / @nht-pandats/sdk/clients / @nht-pandats/sdk/clients/affiliateApi / ModuleFieldDefinition
Interface: ModuleFieldDefinition<T>
@nht-pandats/sdk/clients.@nht-pandats/sdk/clients/affiliateApi.ModuleFieldDefinition
A utility type used for defining the fields of a module model.
Type parameters
| Name | Type | Description |
|---|---|---|
T | any | The type of value of the field. |
Properties
type
• type: T
The type of the field.
Defined in
src/clients/affiliateApi/utils.ts:383
filters
• Optional filters: Partial<{ contain: boolean ; match: boolean ; range: boolean }>
Whether the field can be filtered, and what kind of filters are supported.
Defined in
src/clients/affiliateApi/utils.ts:407
inCreatePayload
• Optional inCreatePayload: boolean
Whether the field can be passed in the create payload.
Defined in
src/clients/affiliateApi/utils.ts:387
inResponsePayload
• Optional inResponsePayload: boolean
Whether the field will be included in the response payload.
Defined in
src/clients/affiliateApi/utils.ts:403
inUpdatePayload
• Optional inUpdatePayload: boolean
Whether the field can be passed in the update payload.
Defined in
src/clients/affiliateApi/utils.ts:395
requiredInCreatePayload
• Optional requiredInCreatePayload: boolean
Whether the field is required in the create payload.
Defined in
src/clients/affiliateApi/utils.ts:391
requiredInUpdatePayload
• Optional requiredInUpdatePayload: boolean
Whether the field is required in the update payload.
Defined in
src/clients/affiliateApi/utils.ts:399
sortable
• Optional sortable: boolean
Whether the field can be sorted.