@tradecafe/offer-service-sdk 0.0.26 → 0.0.27

package/model/createAutomatedOfferDto.ts

@@ -0,0 +1,579 @@
+/**
+ * TradeCafé Offer Service
+ * Offer Service allows supplies to submit product offers into the TradeCafe platform
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+import { CreateOfferDtoAttributes } from './createOfferDtoAttributes';
+import { CreateOfferDtoFormula } from './createOfferDtoFormula';
+import { CreateOfferDtoPacking } from './createOfferDtoPacking';
+import { CreateOfferDtoWeight } from './createOfferDtoWeight';
+import { RelistingDetailDto } from './relistingDetailDto';
+
+export class CreateAutomatedOfferDto {
+    /**
+    * Deal ID
+    */
+    'deal_id'?: string;
+    /**
+    * User ID
+    */
+    'user_id'?: string;
+    /**
+    * Origin deal ID
+    */
+    'origin_deal_id'?: string;
+    /**
+    * Account identifier
+    */
+    'account': string;
+    /**
+    * Country code (uppercase)
+    */
+    'country': string;
+    /**
+    * Product UUID
+    */
+    'product': string;
+    /**
+    * Offer price
+    */
+    'price': number;
+    /**
+    * Currency code (uppercase)
+    */
+    'currency': string;
+    /**
+    * Quantity of the offer
+    */
+    'quantity'?: number;
+    /**
+    * Number of containers
+    */
+    'containers'?: number;
+    /**
+    * Shipment start date (Unix timestamp)
+    */
+    'ship_start': number;
+    /**
+    * Shipment end date (Unix timestamp)
+    */
+    'ship_end': number;
+    /**
+    * Pickup date (Unix timestamp)
+    */
+    'pickup_date'?: number;
+    /**
+    * Offer type
+    */
+    'type': CreateAutomatedOfferDto.TypeEnum;
+    /**
+    * Array of notes
+    */
+    'note'?: Array<string>;
+    /**
+    * Pickup location
+    */
+    'pickup': string;
+    /**
+    * Pickup port
+    */
+    'pickup_port'?: string;
+    /**
+    * Whether pickup location is a port
+    */
+    'pickup_is_port'?: boolean;
+    /**
+    * Expiration time in seconds
+    */
+    'expire_seconds'?: number;
+    /**
+    * Expiration timestamp
+    */
+    'expire'?: number;
+    /**
+    * Establishment information
+    */
+    'establishment'?: string;
+    /**
+    * Array of changes
+    */
+    'changes'?: Array<object>;
+    /**
+    * Offer status
+    */
+    'status'?: CreateAutomatedOfferDto.StatusEnum = CreateAutomatedOfferDto.StatusEnum.NUMBER_0;
+    /**
+    * Wrapping information
+    */
+    'wrapping'?: string;
+    /**
+    * Offer description
+    */
+    'description'?: string;
+    'weight': CreateOfferDtoWeight;
+    /**
+    * Incoterm
+    */
+    'incoterm': string;
+    'packing': CreateOfferDtoPacking;
+    /**
+    * Lot information
+    */
+    'lot'?: string;
+    /**
+    * Whether the offer is private
+    */
+    'isPrivate'?: boolean;
+    /**
+    * Gross margin
+    */
+    'gross_margin'?: number;
+    'attributes'?: CreateOfferDtoAttributes;
+    /**
+    * BWI inventory flag
+    */
+    'bwi_inventory'?: boolean = false;
+    /**
+    * Array of costs
+    */
+    'costs'?: Array<object>;
+    /**
+    * Array of notes
+    */
+    'notes'?: Array<object>;
+    /**
+    * Prioritize matched offer flag
+    */
+    'prioritize_mo'?: boolean = false;
+    /**
+    * Clone source offer ID
+    */
+    'clone_from'?: string;
+    /**
+    * Array of clone offer IDs
+    */
+    'clones'?: Array<string>;
+    /**
+    * Array of buyer IDs
+    */
+    'buyers'?: Array<string>;
+    /**
+    * Array of blocked buyer IDs
+    */
+    'blocked_buyers'?: Array<string>;
+    /**
+    * Array of matched offer IDs
+    */
+    'matched_offers'?: Array<string>;
+    /**
+    * Number of loads
+    */
+    'loads'?: number = 1;
+    /**
+    * Number of loads sold
+    */
+    'loads_sold'?: number = 0;
+    /**
+    * Load parent offer ID
+    */
+    'load_parent'?: string;
+    /**
+    * Array of load offer IDs
+    */
+    'load_offer_ids'?: Array<string>;
+    /**
+    * Array of load deal IDs
+    */
+    'load_deal_ids'?: Array<string>;
+    /**
+    * Whether the offer is biddable
+    */
+    'biddable'?: boolean;
+    /**
+    * Highest bid ratio
+    */
+    'highest_bid_ratio'?: number;
+    /**
+    * Matched offer ID with highest bid
+    */
+    'highest_bid_matched_offer_id'?: string;
+    /**
+    * Number of reloads
+    */
+    'reloads_count'?: number = 0;
+    /**
+    * Without export documents flag
+    */
+    'wo_export_docs'?: boolean;
+    /**
+    * Automated offer ID
+    */
+    'automated_offer_id'?: string;
+    /**
+    * Relisting ID
+    */
+    'relisting_id'?: string;
+    'formula'?: CreateOfferDtoFormula;
+    /**
+    * Product specifications file ID
+    */
+    'product_specs_file_id'?: string;
+    /**
+    * Skip cost matching flag
+    */
+    'skip_cost_matching'?: boolean;
+    /**
+    * Confirmed by user ID
+    */
+    'confirmed_by'?: string;
+    /**
+    * Automated offer status
+    */
+    'automated_offer_status'?: CreateAutomatedOfferDto.AutomatedOfferStatusEnum = CreateAutomatedOfferDto.AutomatedOfferStatusEnum.NUMBER_0;
+    /**
+    * Array of relisting details
+    */
+    'relistings': Array<RelistingDetailDto>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "deal_id",
+            "baseName": "deal_id",
+            "type": "string"
+        },
+        {
+            "name": "user_id",
+            "baseName": "user_id",
+            "type": "string"
+        },
+        {
+            "name": "origin_deal_id",
+            "baseName": "origin_deal_id",
+            "type": "string"
+        },
+        {
+            "name": "account",
+            "baseName": "account",
+            "type": "string"
+        },
+        {
+            "name": "country",
+            "baseName": "country",
+            "type": "string"
+        },
+        {
+            "name": "product",
+            "baseName": "product",
+            "type": "string"
+        },
+        {
+            "name": "price",
+            "baseName": "price",
+            "type": "number"
+        },
+        {
+            "name": "currency",
+            "baseName": "currency",
+            "type": "string"
+        },
+        {
+            "name": "quantity",
+            "baseName": "quantity",
+            "type": "number"
+        },
+        {
+            "name": "containers",
+            "baseName": "containers",
+            "type": "number"
+        },
+        {
+            "name": "ship_start",
+            "baseName": "ship_start",
+            "type": "number"
+        },
+        {
+            "name": "ship_end",
+            "baseName": "ship_end",
+            "type": "number"
+        },
+        {
+            "name": "pickup_date",
+            "baseName": "pickup_date",
+            "type": "number"
+        },
+        {
+            "name": "type",
+            "baseName": "type",
+            "type": "CreateAutomatedOfferDto.TypeEnum"
+        },
+        {
+            "name": "note",
+            "baseName": "note",
+            "type": "Array<string>"
+        },
+        {
+            "name": "pickup",
+            "baseName": "pickup",
+            "type": "string"
+        },
+        {
+            "name": "pickup_port",
+            "baseName": "pickup_port",
+            "type": "string"
+        },
+        {
+            "name": "pickup_is_port",
+            "baseName": "pickup_is_port",
+            "type": "boolean"
+        },
+        {
+            "name": "expire_seconds",
+            "baseName": "expire_seconds",
+            "type": "number"
+        },
+        {
+            "name": "expire",
+            "baseName": "expire",
+            "type": "number"
+        },
+        {
+            "name": "establishment",
+            "baseName": "establishment",
+            "type": "string"
+        },
+        {
+            "name": "changes",
+            "baseName": "changes",
+            "type": "Array<object>"
+        },
+        {
+            "name": "status",
+            "baseName": "status",
+            "type": "CreateAutomatedOfferDto.StatusEnum"
+        },
+        {
+            "name": "wrapping",
+            "baseName": "wrapping",
+            "type": "string"
+        },
+        {
+            "name": "description",
+            "baseName": "description",
+            "type": "string"
+        },
+        {
+            "name": "weight",
+            "baseName": "weight",
+            "type": "CreateOfferDtoWeight"
+        },
+        {
+            "name": "incoterm",
+            "baseName": "incoterm",
+            "type": "string"
+        },
+        {
+            "name": "packing",
+            "baseName": "packing",
+            "type": "CreateOfferDtoPacking"
+        },
+        {
+            "name": "lot",
+            "baseName": "lot",
+            "type": "string"
+        },
+        {
+            "name": "isPrivate",
+            "baseName": "isPrivate",
+            "type": "boolean"
+        },
+        {
+            "name": "gross_margin",
+            "baseName": "gross_margin",
+            "type": "number"
+        },
+        {
+            "name": "attributes",
+            "baseName": "attributes",
+            "type": "CreateOfferDtoAttributes"
+        },
+        {
+            "name": "bwi_inventory",
+            "baseName": "bwi_inventory",
+            "type": "boolean"
+        },
+        {
+            "name": "costs",
+            "baseName": "costs",
+            "type": "Array<object>"
+        },
+        {
+            "name": "notes",
+            "baseName": "notes",
+            "type": "Array<object>"
+        },
+        {
+            "name": "prioritize_mo",
+            "baseName": "prioritize_mo",
+            "type": "boolean"
+        },
+        {
+            "name": "clone_from",
+            "baseName": "clone_from",
+            "type": "string"
+        },
+        {
+            "name": "clones",
+            "baseName": "clones",
+            "type": "Array<string>"
+        },
+        {
+            "name": "buyers",
+            "baseName": "buyers",
+            "type": "Array<string>"
+        },
+        {
+            "name": "blocked_buyers",
+            "baseName": "blocked_buyers",
+            "type": "Array<string>"
+        },
+        {
+            "name": "matched_offers",
+            "baseName": "matched_offers",
+            "type": "Array<string>"
+        },
+        {
+            "name": "loads",
+            "baseName": "loads",
+            "type": "number"
+        },
+        {
+            "name": "loads_sold",
+            "baseName": "loads_sold",
+            "type": "number"
+        },
+        {
+            "name": "load_parent",
+            "baseName": "load_parent",
+            "type": "string"
+        },
+        {
+            "name": "load_offer_ids",
+            "baseName": "load_offer_ids",
+            "type": "Array<string>"
+        },
+        {
+            "name": "load_deal_ids",
+            "baseName": "load_deal_ids",
+            "type": "Array<string>"
+        },
+        {
+            "name": "biddable",
+            "baseName": "biddable",
+            "type": "boolean"
+        },
+        {
+            "name": "highest_bid_ratio",
+            "baseName": "highest_bid_ratio",
+            "type": "number"
+        },
+        {
+            "name": "highest_bid_matched_offer_id",
+            "baseName": "highest_bid_matched_offer_id",
+            "type": "string"
+        },
+        {
+            "name": "reloads_count",
+            "baseName": "reloads_count",
+            "type": "number"
+        },
+        {
+            "name": "wo_export_docs",
+            "baseName": "wo_export_docs",
+            "type": "boolean"
+        },
+        {
+            "name": "automated_offer_id",
+            "baseName": "automated_offer_id",
+            "type": "string"
+        },
+        {
+            "name": "relisting_id",
+            "baseName": "relisting_id",
+            "type": "string"
+        },
+        {
+            "name": "formula",
+            "baseName": "formula",
+            "type": "CreateOfferDtoFormula"
+        },
+        {
+            "name": "product_specs_file_id",
+            "baseName": "product_specs_file_id",
+            "type": "string"
+        },
+        {
+            "name": "skip_cost_matching",
+            "baseName": "skip_cost_matching",
+            "type": "boolean"
+        },
+        {
+            "name": "confirmed_by",
+            "baseName": "confirmed_by",
+            "type": "string"
+        },
+        {
+            "name": "automated_offer_status",
+            "baseName": "automated_offer_status",
+            "type": "CreateAutomatedOfferDto.AutomatedOfferStatusEnum"
+        },
+        {
+            "name": "relistings",
+            "baseName": "relistings",
+            "type": "Array<RelistingDetailDto>"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CreateAutomatedOfferDto.attributeTypeMap;
+    }
+}
+
+export namespace CreateAutomatedOfferDto {
+    export enum TypeEnum {
+        MarketOrder = <any> 'market_order',
+        LimitOrder = <any> 'limit_order',
+        OfferOrder = <any> 'offer_order',
+        StopLoss = <any> 'stop_loss',
+        StopLimit = <any> 'stop_limit'
+    }
+    export enum StatusEnum {
+        NUMBER_0 = <any> 0,
+        NUMBER_1 = <any> 1,
+        NUMBER_2 = <any> 2,
+        NUMBER_3 = <any> 3,
+        NUMBER_4 = <any> 4,
+        NUMBER_5 = <any> 5,
+        NUMBER_6 = <any> 6,
+        NUMBER_7 = <any> 7,
+        NUMBER_8 = <any> 8,
+        NUMBER_9 = <any> 9,
+        NUMBER_10 = <any> 10,
+        NUMBER_MINUS_1 = <any> -1
+    }
+    export enum AutomatedOfferStatusEnum {
+        NUMBER_0 = <any> 0,
+        NUMBER_1 = <any> 1,
+        NUMBER_2 = <any> 2,
+        NUMBER_3 = <any> 3,
+        NUMBER_4 = <any> 4
+    }
+}