contract-template-dto.ts

/* tslint:disable */
/* eslint-disable */
/**
 * Fireblocks API
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: 1.6.2
 * Contact: support@fireblocks.com
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */


// May contain unused imports in some cases
// @ts-ignore
import { AbiFunction } from './abi-function';
// May contain unused imports in some cases
// @ts-ignore
import { ContractAttributes } from './contract-attributes';
// May contain unused imports in some cases
// @ts-ignore
import { ContractDoc } from './contract-doc';
// May contain unused imports in some cases
// @ts-ignore
import { VendorDto } from './vendor-dto';

/**
 * 
 * @export
 * @interface ContractTemplateDto
 */
export interface ContractTemplateDto {
    /**
     * The unique identifier of the contract template
     * @type {string}
     * @memberof ContractTemplateDto
     */
    'id': string;
    /**
     * The name of the contract template
     * @type {string}
     * @memberof ContractTemplateDto
     */
    'name': string;
    /**
     * A short description of the contract template
     * @type {string}
     * @memberof ContractTemplateDto
     */
    'description': string;
    /**
     * The abi of the contract template. Necessary for displaying and for after deployment encoding
     * @type {Array<AbiFunction>}
     * @memberof ContractTemplateDto
     */
    'abi': Array<AbiFunction>;
    /**
     * Is this a contract that is viewable by all fireblocks\'s users or is it visible only for this workspace
     * @type {boolean}
     * @memberof ContractTemplateDto
     */
    'isPublic': boolean;
    /**
     * 
     * @type {string}
     * @memberof ContractTemplateDto
     */
    'initializationPhase': ContractTemplateDtoInitializationPhaseEnum;
    /**
     * A full description of the contract template. May contain   to break the lines
     * @type {string}
     * @memberof ContractTemplateDto
     */
    'longDescription'?: string;
    /**
     * The attributes related to this contract template. It will be displayed in the tokenization page
     * @type {ContractAttributes}
     * @memberof ContractTemplateDto
     */
    'attributes'?: ContractAttributes;
    /**
     * A `natspec` compliant documentation json. Can be retrieved from the output json after compilation
     * @type {ContractDoc}
     * @memberof ContractTemplateDto
     */
    'docs'?: ContractDoc;
    /**
     * The workspace id of the owner of this contract template. If it\'s a private contract, only this workspace will be allowed to deploy it
     * @type {string}
     * @memberof ContractTemplateDto
     */
    'owner'?: string;
    /**
     * The details of the vendor of this contract template. Applicable only for public contract templates
     * @type {VendorDto}
     * @memberof ContractTemplateDto
     */
    'vendor'?: VendorDto;
    /**
     * True if the workspace allowed to deploy this contract, false otherwise
     * @type {boolean}
     * @memberof ContractTemplateDto
     */
    'canDeploy'?: boolean;
    /**
     * The type of the contract template
     * @type {string}
     * @memberof ContractTemplateDto
     */
    'type'?: ContractTemplateDtoTypeEnum;
    /**
     * 
     * @type {string}
     * @memberof ContractTemplateDto
     */
    'implementationContractId'?: string;
}

export const ContractTemplateDtoInitializationPhaseEnum = {
    OnDeployment: 'ON_DEPLOYMENT',
    PostDeployment: 'POST_DEPLOYMENT'
} as const;

export type ContractTemplateDtoInitializationPhaseEnum = typeof ContractTemplateDtoInitializationPhaseEnum[keyof typeof ContractTemplateDtoInitializationPhaseEnum];
export const ContractTemplateDtoTypeEnum = {
    FungibleToken: 'FUNGIBLE_TOKEN',
    NonFungibleToken: 'NON_FUNGIBLE_TOKEN',
    NonToken: 'NON_TOKEN',
    TokenExtension: 'TOKEN_EXTENSION',
    TokenUtility: 'TOKEN_UTILITY'
} as const;

export type ContractTemplateDtoTypeEnum = typeof ContractTemplateDtoTypeEnum[keyof typeof ContractTemplateDtoTypeEnum];