@tolinax/ayoune-interfaces 2024.4.11 → 2024.4.13

package/interfaces/IContract.d.ts

@@ -97,20 +97,20 @@ export interface IContract extends IDefaultFields, IFreeFields {
     _consumerID: ObjectId;
     _receiver: ObjectId;
     suppliers: ObjectId[];
-    user: ObjectId;
-    username: string;
-    team: ObjectId[];
-    agent: string;
-    ayouneApproval: string;
-    ayouneContract: IaYOUneContract;
-    shares: IShare[];
-    done: boolean;
-    resourcesProvided: boolean;
-    resourcesWorking: boolean;
-    locked: boolean;
-    demo: boolean;
-    userDataComplete: boolean;
-    license: {
+    user?: ObjectId;
+    username?: string;
+    team?: ObjectId[];
+    agent?: string;
+    ayouneApproval?: string;
+    ayouneContract?: IaYOUneContract;
+    shares?: IShare[];
+    done?: boolean;
+    resourcesProvided?: boolean;
+    resourcesWorking?: boolean;
+    locked?: boolean;
+    demo?: boolean;
+    userDataComplete?: boolean;
+    license?: {
         active: boolean;
         activated: boolean;
         activatedAt: Date;
@@ -120,90 +120,90 @@ export interface IContract extends IDefaultFields, IFreeFields {
         valid_till: Date;
         userData: string;
     };
-    config: {
+    config?: {
         customConfig: ObjectId;
         useCase: string;
         userData: string;
     };
-    cancelled: boolean;
-    cancelledOn: Date;
-    cancellationReason: string;
-    sendAuto: boolean;
-    useCalculationRule: boolean;
-    hasQuota: boolean;
-    hasDuration: boolean;
-    hasCheckLists: boolean;
-    hasSupplierFeedback: boolean;
-    hasRequirements: boolean;
-    hasLicense: boolean;
-    name: string;
-    internalName: string;
-    additionalName: string;
-    description: string;
-    nbr: number;
-    ext_nbr: number;
-    identifier: number;
-    referenceNumber: string;
-    _productGroup: ObjectId;
-    _product: ObjectId;
-    productTitle: string;
-    opportunity: ObjectId;
-    offer: ObjectId;
-    assignment: ObjectId;
-    project: ObjectId;
-    calendarentry: ObjectId;
-    mode: string;
-    type: string;
-    text_pre: string;
-    text_post: string;
-    pricegroup: ObjectId;
-    discountgroup: ObjectId;
-    paymentcondition: ObjectId;
-    calculationRule: ObjectId;
-    deliverycondition: string;
-    deposits: ObjectId[];
-    interval: string;
-    next_invoice: Date;
-    contract_beginning: Date;
-    contract_end: Date;
-    runtime: number;
-    runtime_type: string;
-    rejected_reason: string;
-    file: ObjectId;
-    positions: IPosition[];
-    note: string;
-    status: string;
-    contract_date: Date;
-    final_discount_percent: number;
-    final_discount_percent_amount: number;
-    final_discount_percent_reason: string;
-    final_discount: number;
-    final_discount_reason: string;
-    shippingCosts: number;
-    totalCosts: number;
-    totalMargin: number;
-    totalMarginPercent: number;
-    totalMarginAfterDiscount: number;
-    totalMarginAfterDiscountPercent: number;
-    sum: number;
-    net_total: number;
-    net_total_external_revenue: number;
-    total: number;
-    setupFee: number;
-    monthly_part: number;
-    total_part: number;
-    external_monthly_part: number;
-    external_total_part: number;
-    paypalPlan: IContractPayPalPlan;
-    paypalSubscription: IContractPaypalSubscription;
-    locale: string;
-    currency: string;
-    foreignCountry: boolean;
-    taxes: any[];
-    attributes: IAttributeValue[];
-    comments: IComment[];
-    watchers: any[];
-    requirements: IRequirement[];
-    warnings: IWarning[];
+    cancelled?: boolean;
+    cancelledOn?: Date;
+    cancellationReason?: string;
+    sendAuto?: boolean;
+    useCalculationRule?: boolean;
+    hasQuota?: boolean;
+    hasDuration?: boolean;
+    hasCheckLists?: boolean;
+    hasSupplierFeedback?: boolean;
+    hasRequirements?: boolean;
+    hasLicense?: boolean;
+    name?: string;
+    internalName?: string;
+    additionalName?: string;
+    description?: string;
+    nbr?: number;
+    ext_nbr?: number;
+    identifier?: number;
+    referenceNumber?: string;
+    _productGroup?: ObjectId;
+    _product?: ObjectId;
+    productTitle?: string;
+    opportunity?: ObjectId;
+    offer?: ObjectId;
+    assignment?: ObjectId;
+    project?: ObjectId;
+    calendarentry?: ObjectId;
+    mode?: string;
+    type?: string;
+    text_pre?: string;
+    text_post?: string;
+    pricegroup?: ObjectId;
+    discountgroup?: ObjectId;
+    paymentcondition?: ObjectId;
+    calculationRule?: ObjectId;
+    deliverycondition?: string;
+    deposits?: ObjectId[];
+    interval?: string;
+    next_invoice?: Date;
+    contract_beginning?: Date;
+    contract_end?: Date;
+    runtime?: number;
+    runtime_type?: string;
+    rejected_reason?: string;
+    file?: ObjectId;
+    positions?: IPosition[];
+    note?: string;
+    status?: string;
+    contract_date?: Date;
+    final_discount_percent?: number;
+    final_discount_percent_amount?: number;
+    final_discount_percent_reason?: string;
+    final_discount?: number;
+    final_discount_reason?: string;
+    shippingCosts?: number;
+    totalCosts?: number;
+    totalMargin?: number;
+    totalMarginPercent?: number;
+    totalMarginAfterDiscount?: number;
+    totalMarginAfterDiscountPercent?: number;
+    sum?: number;
+    net_total?: number;
+    net_total_external_revenue?: number;
+    total?: number;
+    setupFee?: number;
+    monthly_part?: number;
+    total_part?: number;
+    external_monthly_part?: number;
+    external_total_part?: number;
+    paypalPlan?: IContractPayPalPlan;
+    paypalSubscription?: IContractPaypalSubscription;
+    locale?: string;
+    currency?: string;
+    foreignCountry?: boolean;
+    taxes?: any[];
+    attributes?: IAttributeValue[];
+    comments?: IComment[];
+    watchers?: any[];
+    requirements?: IRequirement[];
+    warnings?: IWarning[];
 }
 export {};

package/interfaces/IaYOUneApiAction.d.ts

@@ -20,14 +20,55 @@ export interface IBasicAuth {
     user?: string;
     pass?: string;
 }
+interface ISchema {
+    type: string;
+    items?: ISchema;
+}
+interface IOperation {
+    description?: string;
+    parameters?: {
+        name: string;
+        in: string;
+        description?: string;
+        required?: boolean;
+        schema: {
+            $ref: string;
+        };
+    }[];
+    responses: {
+        [responseCode: string]: {
+            description: string;
+            content?: {
+                [contentType: string]: {
+                    schema: ISchema;
+                };
+            };
+        };
+    };
+}
+interface IPathItem {
+    get?: IOperation;
+    put?: IOperation;
+    post?: IOperation;
+    delete?: IOperation;
+    options?: IOperation;
+    head?: IOperation;
+    patch?: IOperation;
+    trace?: IOperation;
+}
+interface IOpenApiSpec {
+    [path: string]: IPathItem;
+}
 export interface IaYOUneApiAction extends IDefaultFields {
     name?: string;
-    short_description?: string;
+    shortDescription?: string;
     description?: string;
     method?: string;
-    namespace?: string;
+    nameSpace?: string;
     modelName?: string;
     capability?: string;
+    action?: string;
+    operationId?: string;
     output?: string;
     host?: string;
     endpoint?: string;
@@ -38,6 +79,8 @@ export interface IaYOUneApiAction extends IDefaultFields {
     body?: string;
     answer?: string;
     useBasicAuth?: boolean;
-    basicauth?: IBasicAuth;
+    basicAuth?: IBasicAuth;
     debug?: boolean;
+    responses: IOpenApiSpec;
 }
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tolinax/ayoune-interfaces",
-  "version": "2024.4.11",
+  "version": "2024.4.13",
   "description": "Houses TypeScript interfaces for aYOUne",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",