{"name":"api-fraud","organization":{"key":"hbc"},"application":{"key":"api-fraud"},"namespace":"com.hbc.api.fraud.v0","version":"0.0.0-slava","info":{"contact":{"name":"Frozone","email":"frozone@hbc.com"}},"headers":[],"imports":[],"enums":[{"name":"Banner","plural":"Banners","values":[{"name":"lat","attributes":[]},{"name":"s5a","attributes":[]},{"name":"o5a","attributes":[]},{"name":"bay","attributes":[]}],"attributes":[{"name":"DynamoDBTypeConvertedEnum","value":{}}],"description":"Our lovely store chains"},{"name":"CustomerType","plural":"CustomerTypes","values":[{"name":"guest","attributes":[]},{"name":"registered","attributes":[]},{"name":"employee","attributes":[]}],"attributes":[{"name":"DynamoDBTypeConvertedEnum","value":{}}],"description":"Possible types of customers"},{"name":"RecommendationCode","plural":"RecommendationCodes","values":[{"name":"reject","attributes":[]},{"name":"review","attributes":[]},{"name":"accept","attributes":[]}],"attributes":[{"name":"DynamoDBTypeConvertedEnum","value":{}}],"description":"Enum describing the possible responses"}],"interfaces":[],"unions":[],"models":[{"name":"AdditionalData","plural":"AdditionalDatas","fields":[{"name":"inAuthId","type":"uuid","required":true,"attributes":[],"annotations":[]}],"attributes":[],"interfaces":[],"description":"Envelope data"},{"name":"Address","plural":"Addresses","fields":[{"name":"name","type":"string","required":true,"attributes":[],"annotations":[]},{"name":"streetLineOne","type":"string","required":true,"attributes":[],"annotations":[]},{"name":"streetLineTwo","type":"string","required":false,"attributes":[],"annotations":[]},{"name":"city","type":"string","required":true,"attributes":[],"annotations":[]},{"name":"state","type":"string","required":true,"attributes":[],"annotations":[]},{"name":"zip","type":"string","required":true,"attributes":[],"annotations":[]},{"name":"country","type":"string","required":true,"attributes":[],"annotations":[]}],"attributes":[{"name":"DynamoDBDocument","value":{}}],"interfaces":[],"description":"General address model"},{"name":"CreditCard","plural":"CreditCards","fields":[{"name":"nameOnCard","type":"string","required":true,"attributes":[],"annotations":[]},{"name":"billingAddress","type":"Address","required":true,"attributes":[],"annotations":[]},{"name":"cardType","type":"string","required":true,"attributes":[],"annotations":[]},{"name":"cardNumber","type":"string","required":true,"attributes":[],"annotations":[]},{"name":"authorizedAmount","type":"decimal","required":true,"attributes":[],"annotations":[]},{"name":"fullAmount","type":"decimal","required":true,"attributes":[],"annotations":[]},{"name":"expiryDate","type":"string","required":true,"attributes":[],"annotations":[],"description":"MM-YY that the credit card expires"},{"name":"authCode","type":"string","required":true,"attributes":[],"annotations":[],"description":"CVV code on the back of the card"},{"name":"responseCode","type":"integer","required":true,"attributes":[],"annotations":[]},{"name":"merchantId","type":"integer","required":false,"attributes":[],"annotations":[]},{"name":"registerNumber","type":"string","required":false,"attributes":[],"annotations":[]},{"name":"transactionNumber","type":"string","required":true,"attributes":[],"annotations":[]},{"name":"avsResponse","type":"string","required":true,"attributes":[],"annotations":[],"description":"Address Verification System response, Codes are available here: https://www.chasepaymentech.com/address_verification_service.html"}],"attributes":[{"name":"DynamoDBDocument","value":{}}],"interfaces":[],"description":"A customer's complete credit card information"},{"name":"Customer","plural":"Customers","fields":[{"name":"customerType","type":"CustomerType","required":true,"attributes":[],"annotations":[]},{"name":"accountId","type":"string","required":true,"attributes":[],"annotations":[]},{"name":"creationDate","type":"date-iso8601","required":true,"attributes":[],"annotations":[]},{"name":"firstName","type":"string","required":true,"attributes":[],"annotations":[]},{"name":"lastName","type":"string","required":true,"attributes":[],"annotations":[]},{"name":"emailAddress","type":"string","required":true,"attributes":[],"annotations":[]}],"attributes":[{"name":"DynamoDBDocument","value":{}}],"interfaces":[],"description":"Customer model"},{"name":"DBRecord","plural":"DBRecords","fields":[{"name":"transactionId","type":"string","required":true,"attributes":[{"name":"DynamoDBHashKey","value":{"attributeName":"transactionId"}}],"annotations":[]},{"name":"lastModifiedDate","type":"date-iso8601","required":false,"attributes":[{"name":"DynamoDBRangeKey","value":{"attributeName":"lastModifiedDate"}}],"annotations":[]},{"name":"createdDate","type":"date-iso8601","required":false,"attributes":[],"annotations":[],"description":"Date this record was first created within the database"},{"name":"transaction","type":"Transaction","required":true,"attributes":[],"annotations":[]},{"name":"decision","type":"Decision","required":true,"attributes":[],"annotations":[]}],"attributes":[{"name":"DynamoDBTable","value":{"tableName":"fraud_service_orders_dev"}}],"interfaces":[],"description":"Response model to OMS containing the transaction they've sent and the decision we've made"},{"name":"Decision","plural":"Decisions","fields":[{"name":"transactionId","type":"string","required":true,"attributes":[],"annotations":[]},{"name":"recommendationCode","type":"RecommendationCode","required":true,"attributes":[],"annotations":[]},{"name":"crossReference","type":"uuid","required":false,"attributes":[],"annotations":[]},{"name":"rulesTripped","type":"string","required":false,"attributes":[],"annotations":[]},{"name":"totalScore","type":"integer","required":true,"attributes":[],"annotations":[]},{"name":"remarks","type":"string","required":false,"attributes":[],"annotations":[]}],"attributes":[{"name":"DynamoDBDocument","value":{}}],"interfaces":[],"description":"Defines decision information"},{"name":"Error","plural":"Errors","fields":[{"name":"message","type":"string","required":true,"attributes":[],"annotations":[],"description":"Error description message","example":"Oops, something went wrong!"},{"name":"error","type":"string","required":true,"attributes":[],"annotations":[],"description":"Error code","example":"invalid_email"}],"attributes":[],"interfaces":[],"description":"Error response model"},{"name":"Item","plural":"Items","fields":[{"name":"svsNumber","type":"integer","required":true,"attributes":[],"annotations":[],"description":"Product style number (parent number)"},{"name":"skuNumber","type":"integer","required":true,"attributes":[],"annotations":[],"description":"HBC internally generated number for items (alias SKN)"},{"name":"upcNumber","type":"integer","required":false,"attributes":[],"annotations":[],"description":"The number on the barcode that could be used across different retailers"},{"name":"classNumber","type":"integer","required":false,"attributes":[],"annotations":[],"description":"Signifies business category of an item (pants, tops, shirts, etc.)"},{"name":"color","type":"string","required":false,"attributes":[],"annotations":[]},{"name":"size","type":"string","required":false,"attributes":[],"annotations":[]},{"name":"currentStatus","type":"string","required":true,"attributes":[],"annotations":[]},{"name":"department","type":"integer","required":true,"attributes":[],"annotations":[]},{"name":"signOnDelivery","type":"string","required":false,"attributes":[],"annotations":[]},{"name":"giftWrapped","type":"boolean","required":false,"attributes":[],"annotations":[]},{"name":"costAmount","type":"decimal","required":false,"attributes":[],"annotations":[]},{"name":"marginAmount","type":"decimal","required":false,"attributes":[],"annotations":[]},{"name":"description","type":"string","required":true,"attributes":[],"annotations":[]},{"name":"price","type":"decimal","required":true,"attributes":[],"annotations":[],"description":"Price of single item"},{"name":"extendedPrice","type":"decimal","required":true,"attributes":[],"annotations":[],"description":"Total price of all items ordered"},{"name":"quantity","type":"integer","required":true,"attributes":[],"annotations":[]},{"name":"groupNumber","type":"integer","required":true,"attributes":[],"annotations":[]},{"name":"shippingAddress","type":"Address","required":true,"attributes":[],"annotations":[]},{"name":"shippingMethod","type":"string","required":true,"attributes":[],"annotations":[]},{"name":"shippingCountry","type":"string","required":true,"attributes":[],"annotations":[]}],"attributes":[{"name":"DynamoDBDocument","value":{}}],"interfaces":[],"description":"Single item"},{"name":"Promo","plural":"Promoes","fields":[{"name":"promotionCode","type":"string","required":true,"attributes":[],"annotations":[]},{"name":"promotionAmount","type":"decimal","required":true,"attributes":[],"annotations":[],"description":"Dollar amount discounted by the promotion"}],"attributes":[{"name":"DynamoDBDocument","value":{}}],"interfaces":[],"description":"Promotion model"},{"name":"Transaction","plural":"Transactions","fields":[{"name":"orderId","type":"string","required":true,"attributes":[],"annotations":[]},{"name":"groupId","type":"string","required":true,"attributes":[],"annotations":[]},{"name":"orderTotal","type":"decimal","required":true,"attributes":[],"annotations":[]},{"name":"shippingCost","type":"decimal","required":true,"attributes":[],"annotations":[]},{"name":"currencyCode","type":"string","required":true,"attributes":[],"annotations":[]},{"name":"storeNumber","type":"integer","required":true,"attributes":[],"annotations":[]},{"name":"salesRep","type":"string","required":false,"attributes":[],"annotations":[]},{"name":"lastModifiedDate","type":"date-iso8601","required":false,"attributes":[],"annotations":[]},{"name":"banner","type":"Banner","required":true,"attributes":[],"annotations":[]},{"name":"creditCard","type":"CreditCard","required":true,"attributes":[],"annotations":[]},{"name":"promos","type":"[Promo]","required":false,"attributes":[],"annotations":[]},{"name":"items","type":"[Item]","required":true,"attributes":[],"annotations":[]},{"name":"ipAddress","type":"string","required":false,"attributes":[],"annotations":[]},{"name":"source","type":"string","required":true,"attributes":[],"annotations":[],"description":"Order source (web, store, etc)"},{"name":"customer","type":"Customer","required":true,"attributes":[],"annotations":[]},{"name":"additionalData","type":"AdditionalData","required":false,"attributes":[],"annotations":[],"description":"Additional `envelope` data sent through our system to f-s, should include InAuthId"}],"attributes":[],"interfaces":[],"description":"Defines data expected to come in from OMS describing a transaction"}],"resources":[{"type":"Decision","plural":"Decisions","operations":[{"method":"POST","path":"/decision","parameters":[],"responses":[{"code":{"integer":{"value":200}},"type":"unit","attributes":[]},{"code":{"integer":{"value":400}},"type":"[Error]","attributes":[]}],"attributes":[],"description":"Consumes the decision about a transaction (usually meant for manual review) and triggers OMS to process/cancel the order","body":{"type":"Decision","attributes":[]}}],"attributes":[],"path":"/decision"},{"type":"Transaction","plural":"Transactions","operations":[{"method":"POST","path":"/transaction","parameters":[],"responses":[{"code":{"integer":{"value":200}},"type":"Decision","attributes":[]},{"code":{"integer":{"value":400}},"type":"[Error]","attributes":[]}],"attributes":[],"description":"Provides decision about a transaction by supplying order or other information","body":{"type":"Transaction","attributes":[]}}],"attributes":[],"path":"/transaction","description":"Store a transaction and give an immediate yes/no/maybe decision, if maybe send to manual review and await other endpoint"}],"attributes":[],"annotations":[],"apidoc":{"version":"0.0.0-slava"},"base_url":"http://fraud-frozone","description":"API documentation for the fraud service"}