/** * Trading Partners config format within Trellis * @example * ```json * { * "sapid": "1234567890", * "masterid": "1234567890", * "companycode": "1234567890", * "vendorid": "1234567890", * "partnerid": "1234567890", * "name": "Tyson Foods", * "address": "2550 Yeager Road", * "city": "West Lafayette", * "state": "Indiana", * "type": "customer", * "source": "business", * "coi_emails": "example@example.com", * "fsqa_emails": "example@example.com", * "email": "example@example.com", * "phone": "111-222-3333" * } * ``` * * * File automatically generated using json-schema-to-typescript. * ! DO NOT MODIFY IT BY HAND ! * Instead, modify the source file ./trellis/trading-partners/trading-partner.schema.json of @oada/formats * and run `$ yarn build` to regenerate this file. * * @packageDocumentation */ /** * `$id` of the source schema * @see {@link https://formats.openag.io/trellis/trading-partner.schema.json} */ export declare const $id = "https://formats.openag.io/trellis/trading-partner.schema.json"; /** * JSON Schema used to generate this type * @see {@link https://formats.openag.io/trellis/trading-partner.schema.json} */ export declare const schema: { readonly $id: "https://formats.openag.io/trellis/trading-partner.schema.json"; readonly $schema: "http://json-schema.org/draft-07/schema#"; readonly description: "Trading Partners config format within Trellis"; readonly type: "object"; readonly properties: { readonly sapid: { readonly type: "string"; }; readonly masterid: { readonly type: "string"; }; readonly companycode: { readonly type: "string"; }; readonly vendorid: { readonly type: "string"; }; readonly partnerid: { readonly type: "string"; }; readonly name: { readonly type: "string"; }; readonly address: { readonly type: "string"; }; readonly city: { readonly type: "string"; }; readonly state: { readonly type: "string"; }; readonly type: { readonly type: "string"; }; readonly source: { readonly type: "string"; }; readonly coi_emails: { readonly type: "string"; }; readonly fsqa_emails: { readonly type: "string"; }; readonly email: { readonly type: "string"; }; readonly phone: { readonly type: "string"; }; }; readonly required: readonly ["sapid", "masterid", "name"]; readonly examples: readonly [{ readonly sapid: "1234567890"; readonly masterid: "1234567890"; readonly companycode: "1234567890"; readonly vendorid: "1234567890"; readonly partnerid: "1234567890"; readonly name: "Tyson Foods"; readonly address: "2550 Yeager Road"; readonly city: "West Lafayette"; readonly state: "Indiana"; readonly type: "customer"; readonly source: "business"; readonly coi_emails: "example@example.com"; readonly fsqa_emails: "example@example.com"; readonly email: "example@example.com"; readonly phone: "111-222-3333"; }]; }; /** * Returns true if `val` is a @type `TradingPartnerSchema`, false otherwise */ export declare function is(val: unknown): val is TradingPartnerSchema; /** * Asserts that `val` is a @type `TradingPartnerSchema` */ export declare function assert(val: unknown): asserts val is TradingPartnerSchema; /** * Trading Partners config format within Trellis * @example * ```json * { * "sapid": "1234567890", * "masterid": "1234567890", * "companycode": "1234567890", * "vendorid": "1234567890", * "partnerid": "1234567890", * "name": "Tyson Foods", * "address": "2550 Yeager Road", * "city": "West Lafayette", * "state": "Indiana", * "type": "customer", * "source": "business", * "coi_emails": "example@example.com", * "fsqa_emails": "example@example.com", * "email": "example@example.com", * "phone": "111-222-3333" * } * ``` * */ export default TradingPartnerSchema; /** * Trading Partners config format within Trellis */ export interface TradingPartnerSchema { sapid: string; masterid: string; companycode?: string; vendorid?: string; partnerid?: string; name: string; address?: string; city?: string; state?: string; type?: string; source?: string; coi_emails?: string; fsqa_emails?: string; email?: string; phone?: string; [k: string]: unknown; }