{"swagger":"2.0","info":{"version":"v1","title":"1World Online backend API"},"tags":[{"name":"AccountBalanceCommand"},{"name":"AccountBalanceQuery"},{"name":"BeeswaxCommand"},{"name":"ExportReport"},{"name":"PartnerQueries"},{"name":"PollVoteCommand"},{"name":"SyntheticAccountCommand"},{"name":"campaign api"},{"name":"category api"}],"paths":{"/account/balance/activity/{targetAccountId}/{currency}":{"get":{"tags":["AccountBalanceQuery"],"summary":"List activities linked with balance","description":"","operationId":"findActivity","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"targetAccountId","in":"path","required":true,"type":"integer","format":"int64"},{"name":"currency","in":"path","required":true,"type":"string"},{"name":"","in":"query","required":false,"type":"integer","format":"int32"},{"name":"","in":"query","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/AccountBalanceActivityDto"}}}}}},"/account/balance/all/{currency}":{"get":{"tags":["AccountBalanceQuery"],"summary":"List balances for a certain currency","description":"","operationId":"findAllBalance","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"currency","in":"path","required":true,"type":"string"},{"name":"","in":"query","required":false,"type":"integer","format":"int32"},{"name":"","in":"query","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/AccountBalanceDto"}}}}}},"/account/balance/bank/invoice/accept/{invoiceId}":{"post":{"tags":["AccountBalanceCommand"],"summary":"Acceptance of the bank invoice and enroll all related funds to account balance","description":"","operationId":"acceptInvoice","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"invoiceId","in":"path","required":true,"type":"integer","format":"int64"},{"name":"","in":"query","required":true,"type":"string"},{"name":"","in":"query","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PaymentResponse"}},"202":{"description":""}}}},"/account/balance/bank/invoice/reject/{invoiceId}":{"post":{"tags":["AccountBalanceCommand"],"summary":"Bank invoice rejection","description":"","operationId":"rejectInvoice","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"invoiceId","in":"path","required":true,"type":"integer","format":"int64"},{"name":"","in":"query","required":true,"type":"string"}],"responses":{"202":{"description":""}}}},"/account/balance/crypto/transaction/accept/{transactionId}":{"post":{"tags":["AccountBalanceCommand"],"summary":"Acceptance of the crypto transaction and enroll all related funds to account balance","description":"","operationId":"enrollCryptoFunds","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"transactionId","in":"path","required":true,"type":"integer","format":"int64"},{"name":"targetAccount","in":"query","required":true,"type":"integer","format":"int64"},{"name":"","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PaymentResponse"}},"202":{"description":""}}}},"/account/balance/inspectRefundForCampaign/{campaignId}":{"get":{"tags":["AccountBalanceCommand"],"summary":"Review the remaining funds from the campaign to account balance","description":"","operationId":"inspectRefundOptionCampaign","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"campaignId","in":"path","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PaymentResponse"}},"202":{"description":""}}}},"/account/balance/me":{"get":{"tags":["AccountBalanceQuery"],"summary":"List balances active user","description":"","operationId":"findBalances","produces":["application/json;charset=UTF-8"],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/AccountBalanceDto"}}}}}},"/account/balance/me/{currency}":{"get":{"tags":["AccountBalanceQuery"],"summary":"User balance entity for a certain currency","description":"","operationId":"findBalance","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"currency","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AccountBalanceDto"}}}}},"/account/balance/me/{currency}/payments":{"get":{"tags":["AccountBalanceQuery"],"summary":"List payments for an active user and certain currency","description":"","operationId":"getPayments","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"currency","in":"path","required":true,"type":"string"},{"name":"","in":"query","required":false,"type":"integer","format":"int32"},{"name":"","in":"query","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/PaymentEntityDto"}}}}}},"/account/balance/refundFromCampaign/{campaignId}":{"post":{"tags":["AccountBalanceCommand"],"summary":"Refund remaining funds from the campaign to account balance","description":"","operationId":"refundFromCampaign","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"campaignId","in":"path","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PaymentResponse"}},"202":{"description":""}}}},"/account/balance/{currency}/bank/invoice":{"post":{"tags":["AccountBalanceCommand"],"summary":"Register bank invoice inside the system to enroll the funds to account balance upon accepting that invoice","description":"","operationId":"registerBankInvoice","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"currency","in":"path","required":true,"type":"string"},{"name":"","in":"query","required":true,"type":"integer","format":"int64"},{"name":"","in":"query","required":true,"type":"string"},{"name":"","in":"query","required":false,"type":"ref"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PaymentCheckout"}}}}},"/account/balance/{currency}/checkout":{"get":{"tags":["AccountBalanceCommand"],"summary":"Checkout flow for the fiat currency to see mandatory information to refill account balance","description":"","operationId":"checkout","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"currency","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PaymentCheckout"}}}}},"/account/balance/{currency}/cryptoCheckout":{"get":{"tags":["AccountBalanceCommand"],"summary":"Checkout flow for crypto currency to refill account balance","description":"","operationId":"cryptoCheckout","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"currency","in":"path","required":true,"type":"string"},{"name":"","in":"query","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PaymentCheckout"}}}}},"/account/balance/{currency}/lock":{"post":{"tags":["AccountBalanceCommand"],"summary":"Lock account balance","description":"","operationId":"lock","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"currency","in":"path","required":true,"type":"string"},{"name":"targetAccount","in":"query","required":true,"type":"integer","format":"int64"},{"name":"","in":"query","required":true,"type":"string"}],"responses":{"202":{"description":""}}}},"/account/balance/{currency}/refill/inputCard":{"post":{"tags":["AccountBalanceCommand"],"summary":"Replenishment account balance by credit card","description":"","operationId":"refillByInputCardUsd","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"currency","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ChargeDto"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PaymentResponse"}}}}},"/account/balance/{currency}/refill/savedCard":{"post":{"tags":["AccountBalanceCommand"],"summary":"Replenishment account balance by saved credit card","description":"","operationId":"refillBySavedCardUsd","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"currency","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ChargeDto"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PaymentResponse"}}}}},"/account/balance/{currency}/unlock":{"post":{"tags":["AccountBalanceCommand"],"summary":"UnLock account balance","description":"","operationId":"unlock","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"currency","in":"path","required":true,"type":"string"},{"name":"targetAccount","in":"query","required":true,"type":"integer","format":"int64"},{"name":"","in":"query","required":true,"type":"string"}],"responses":{"202":{"description":""}}}},"/account/balance/{currency}/withdrawToCampaign":{"post":{"tags":["AccountBalanceCommand"],"summary":"Pay for a campaign from account balance","description":"","operationId":"withdrawToCampaign","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"currency","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ChargeDto"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PaymentResponse"}},"202":{"description":""}}}},"/beeswax/campaign/directDeal":{"post":{"tags":["BeeswaxCommand"],"summary":"Creatation a beeswax campaign entity with DirectDeal style for certain 1w campaign","description":"","operationId":"createBeeswaxCampaignDirectDeal","produces":["application/json;charset=UTF-8"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/BeeswaxCampaignRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BeeswaxActionResponse"}}}}},"/beeswax/campaign/openOption":{"post":{"tags":["BeeswaxCommand"],"summary":"Creation a beeswax campaign entity with OpenOption style for certain 1w campaign","description":"","operationId":"createBeeswaxCampaignOpenOption","produces":["application/json;charset=UTF-8"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/BeeswaxCampaignRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BeeswaxActionResponse"}}}}},"/beeswax/campaign/{oneworldCampaignId}/all":{"get":{"tags":["BeeswaxCommand"],"summary":"Getting list of beeswax campaign entities for certain 1w campaign","description":"","operationId":"getBeeswaxCampaigns","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"oneworldCampaignId","in":"path","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/BeeswaxCampaignDto"}}}}}},"/beeswax/campaign/{oneworldCampaignId}/directDeal":{"get":{"tags":["BeeswaxCommand"],"summary":"Getting a beeswax campaign with DirectDeal style for certain 1w campaign","description":"","operationId":"getBeeswaxDirectDealCampaign","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"oneworldCampaignId","in":"path","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BeeswaxCampaignDto"}}}}},"/beeswax/campaign/{oneworldCampaignId}/directDeal/changeActive":{"put":{"tags":["BeeswaxCommand"],"summary":"Activate/InActivate a beeswax campaign entity with DirectDeal style for certain 1w campaign","description":"","operationId":"updateDirectDealOpenOptionCampaign","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"oneworldCampaignId","in":"path","required":true,"type":"integer","format":"int64"},{"name":"","in":"query","required":true,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"type":"integer","format":"int64"}}}}},"/beeswax/campaign/{oneworldCampaignId}/openOption":{"get":{"tags":["BeeswaxCommand"],"summary":"Getting a beeswax campaign entity with OpenOption style for certain 1w campaign","description":"","operationId":"getBeeswaxOpenOptionCampaign","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"oneworldCampaignId","in":"path","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BeeswaxCampaignDto"}}}}},"/beeswax/campaign/{oneworldCampaignId}/openOption/changeActive":{"put":{"tags":["BeeswaxCommand"],"summary":"Activate/InActivate a beeswax campaign entity with OpenOption style for certain 1w campaign","description":"","operationId":"updateActiveStatusOpenOptionCampaign","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"oneworldCampaignId","in":"path","required":true,"type":"integer","format":"int64"},{"name":"","in":"query","required":true,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"type":"integer","format":"int64"}}}}},"/beeswax/targeting/category/all":{"get":{"tags":["BeeswaxCommand"],"summary":"Getting list of beeswax categories applicable for targeting","description":"","operationId":"getCategories","produces":["application/json;charset=UTF-8"],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/BeeswaxIdNameEntity"}}}}}},"/beeswax/targeting/directDeal/partners":{"get":{"tags":["BeeswaxCommand"],"summary":"Getting partner details (aggregation) where adUnits applicable for directDeal flow ","description":"","operationId":"getDirectDealPartners","produces":["application/json;charset=UTF-8"],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/BeeswaxDirectDealPartnerEntity"}}}}}},"/beeswax/targeting/directDeal/partners/adUnits":{"get":{"tags":["BeeswaxCommand"],"summary":"Getting adUnits for directDeal flow for a all partner","description":"","operationId":"getDirectDealAdUnits","produces":["application/json;charset=UTF-8"],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/BeeswaxDirectDealPartnerEntity"}}}}}},"/beeswax/targeting/directDeal/partners/{partnerExternalId}/adUnits":{"get":{"tags":["BeeswaxCommand"],"summary":"Getting adUnits for directDeal flow for a certain partner","description":"","operationId":"getDirectDealAdUnits","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"partnerExternalId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/BeeswaxDirectDealPartnerEntity"}}}}}},"/beeswax/targeting/inventory/all":{"get":{"tags":["BeeswaxCommand"],"summary":"Getting list of beeswax inventorty items applicable for targeting","description":"","operationId":"getInventories","produces":["application/json;charset=UTF-8"],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/BeeswaxIdNameEntity"}}}}}},"/beeswax/targeting/inventory/default":{"get":{"tags":["BeeswaxCommand"],"summary":"Getting default list of beeswax inventorty items applicable for targeting","description":"","operationId":"getDefInventories","produces":["application/json;charset=UTF-8"],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/BeeswaxIdNameEntity"}}}}}},"/beeswax/targeting/language/all":{"get":{"tags":["BeeswaxCommand"],"summary":"Getting list of beeswax languages applicable for targeting","description":"","operationId":"getLanguages","produces":["application/json;charset=UTF-8"],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/BeeswaxIdNameEntity"}}}}}},"/campaigns":{"get":{"tags":["campaign api"],"summary":"List campaigns","description":"","operationId":"getCampaigns","parameters":[{"name":"sortCriteria","in":"query","required":false,"type":"string"},{"name":"sortType","in":"query","required":false,"type":"string"},{"name":"name","in":"query","required":false,"type":"string"},{"name":"status","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"expectedCurrency","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"type","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"page","in":"query","required":false,"type":"integer","format":"int32"},{"name":"pageSize","in":"query","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/CampaignDto"}}}}},"post":{"tags":["campaign api"],"summary":"Creates a new campaign with status=DRAFT. Allowed for role Advertiser","description":"","operationId":"createCampaign","parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CampaignDto"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignDto"}}}}},"/campaigns/brand/{advertiserId}":{"get":{"tags":["campaign api"],"summary":"get advertiser campaigns list with pager","description":"","operationId":"getCampaignsByAdvertiserId","parameters":[{"in":"body","name":"body","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"advertiserId","in":"path","required":true,"type":"integer","format":"int64"},{"name":"","in":"query","required":false,"type":"string"},{"name":"","in":"query","required":false,"type":"string"},{"name":"","in":"query","required":false,"type":"string"},{"name":"","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"","in":"query","required":false,"type":"integer","format":"int32"},{"name":"","in":"query","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/CampaignDto"}}}}}},"/campaigns/{campaignId}/clone":{"post":{"tags":["campaign api"],"summary":"Campaign cloning","description":"","operationId":"clone","parameters":[{"in":"body","name":"body","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"campaignId","in":"path","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignDto"}}}}},"/categories":{"get":{"tags":["category api"],"summary":"get list of all categories by locale","description":"","operationId":"allCategory","produces":["application/json;charset=UTF-8"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/CampaignDto"}}}}}},"/categories/entity/list":{"get":{"tags":["category api"],"summary":"get list of all categories with pager. Allowed only for SuperAdmin role","description":"","operationId":"getCategories","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"","in":"query","description":"list of statuses by which could be filtered categories. Return all if status not specified","required":false,"type":"array","items":{"type":"string","enum":["published","unpublished","etc"]},"collectionFormat":"multi"},{"name":"","in":"query","description":"which page should be returned","required":false,"type":"integer","default":0,"format":"int32"},{"name":"","in":"query","description":"page size of the result","required":false,"type":"integer","default":10,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/CampaignDto"}}}}}},"/categories/entity/{id}":{"get":{"tags":["category api"],"summary":"get category by id","description":"","operationId":"getCategory","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"id","in":"path","description":"category id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CategoryDto"}}}}},"/partners/current":{"get":{"tags":["PartnerQueries"],"summary":"Find current user's partner","description":"","operationId":"onFindCurrent","responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PartnerWithParentDetailsDto"}}}}},"/partners/{externalId}":{"get":{"tags":["PartnerQueries"],"summary":"Find partner by external id","description":"","operationId":"onFindPartnerByExternalId","parameters":[{"name":"externalId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PartnerWithParentDetailsDto"}}}}},"/poll-vote/poll-side/{sideId}":{"post":{"tags":["PollVoteCommand"],"summary":"Votes for some poll's side","description":"","operationId":"pollVoteMultipleSides","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"sideId","in":"path","required":true,"type":"integer","format":"int64"},{"name":"sourceType","in":"query","required":false,"type":"string"},{"name":"sourceCode","in":"query","required":false,"type":"string"},{"name":"widgetCode","in":"query","required":false,"type":"string"},{"name":"surveyAccount","in":"query","required":false,"type":"string"},{"name":"urlVotedFrom","in":"query","required":false,"type":"string"},{"name":"increaseView","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PollVoteDto"}}}}},"/report/{campaignId}/export":{"get":{"tags":["ExportReport"],"summary":"Generate file of the report for finished campaign","description":"","operationId":"exportCampaignReport","produces":["application/pdf"],"parameters":[{"name":"campaignId","in":"path","required":true,"type":"integer","format":"int64"},{"name":"","in":"query","required":false,"type":"string"},{"name":"","in":"query","required":true,"type":"string","enum":["PDF"]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string","format":"byte"}}}}}},"/synthetic/activity/transfer":{"post":{"tags":["SyntheticAccountCommand"],"summary":"Transfer activity from synthetic user to target 1w user.","description":"","operationId":"transferData","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"sourceId","in":"query","required":true,"type":"integer","format":"int64"},{"name":"targetId","in":"query","required":true,"type":"integer","format":"int64"}],"responses":{"202":{"description":""}}}}},"definitions":{"AccountBalanceActivityDto":{"type":"object","required":["account","action","amount","comment","currency","executed","executedBy","totalAmount"],"properties":{"account":{"$ref":"#/definitions/AccountMinimalDto"},"currency":{"type":"string","enum":["USD","OneWorld"]},"amount":{"type":"number"},"totalAmount":{"type":"number"},"action":{"type":"string","enum":["InvoiceCreation","InvoiceAcceptance","InvoiceRejection","Refill","Withdrawal","Refund","Blocking","UnBlocking"]},"comment":{"type":"string"},"executed":{"type":"string"},"executedBy":{"$ref":"#/definitions/AccountMinimalDto"}}},"AccountBalanceDto":{"type":"object","required":["account","amount","created","currency","status","updated"],"properties":{"account":{"$ref":"#/definitions/AccountMinimalDto"},"amount":{"type":"number"},"currency":{"type":"string","enum":["USD","OneWorld"]},"status":{"type":"string","enum":["Active","Locked"]},"created":{"type":"string"},"updated":{"type":"string"}}},"AccountMinimalDto":{"type":"object","required":["first","id","last","roles","thumbnailUrl","username"],"properties":{"id":{"type":"integer","format":"int64"},"username":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"thumbnailUrl":{"type":"string"},"roles":{"type":"array","uniqueItems":true,"items":{"type":"string"}}}},"AdUnitDto":{"type":"object","required":["dfpCode","drctCmpgnCpm","height","id","jsCode","name","network","networkId","partnerId","size","statsOnly","width"],"properties":{"id":{"type":"string"},"partnerId":{"type":"string"},"name":{"type":"string"},"height":{"type":"integer","format":"int64"},"width":{"type":"integer","format":"int64"},"jsCode":{"type":"string"},"network":{"type":"string"},"networkId":{"type":"string"},"dfpCode":{"type":"string"},"size":{"type":"string"},"statsOnly":{"type":"boolean"},"drctCmpgnCpm":{"type":"number","format":"double"}}},"AdvertiserDto":{"type":"object","required":["accepted","acceptedBy","accounts","adStatus","apiAccess","apiKey","brandType","category","categoryId","contactEmail","contactName","contactPhone","createdBy","customerType","defaultLanguage","defaultTimeZone","domain","ehsPublisherId","externalId","goals","id","importance","isAccepted","name","pageviews","parent","pricing","protected","redirectUrl","regionId","showAdStats","slugName","subdomain","tags","visits","widgetIcon"],"properties":{"id":{"type":"integer","format":"int64"},"externalId":{"type":"string"},"name":{"type":"string"},"widgetIcon":{"$ref":"#/definitions/AttachmentDto"},"adStatus":{"type":"string"},"redirectUrl":{"type":"string"},"apiKey":{"type":"string"},"accounts":{"type":"array","items":{"$ref":"#/definitions/AccountMinimalDto"}},"domain":{"type":"string"},"subdomain":{"type":"string"},"contactName":{"type":"string"},"contactPhone":{"type":"string"},"contactEmail":{"type":"string"},"defaultLanguage":{"type":"string"},"createdBy":{"$ref":"#/definitions/AccountMinimalDto"},"pricing":{"type":"string"},"isAccepted":{"type":"boolean"},"accepted":{"type":"integer","format":"int64"},"acceptedBy":{"$ref":"#/definitions/AccountMinimalDto"},"ehsPublisherId":{"type":"string"},"defaultTimeZone":{"type":"string"},"tags":{"type":"string"},"importance":{"type":"string"},"customerType":{"type":"string"},"categoryId":{"type":"integer","format":"int64"},"category":{"$ref":"#/definitions/Category"},"regionId":{"type":"integer","format":"int64"},"visits":{"type":"integer","format":"int64"},"pageviews":{"type":"integer","format":"int64"},"apiAccess":{"type":"string"},"parent":{"type":"integer","format":"int64"},"showAdStats":{"type":"boolean"},"slugName":{"type":"string"},"goals":{"type":"array","items":{"type":"string"}},"brandType":{"type":"string"},"protected":{"type":"boolean"}}},"AttachmentDto":{"type":"object","required":["guid","type","url"],"properties":{"guid":{"type":"string","description":"Unique identifier"},"type":{"type":"string","description":"Type"},"url":{"type":"string","description":"Url"}},"description":"Attachment object"},"BeeswaxActionResponse":{"type":"object","required":["messages","result"],"properties":{"messages":{"type":"array","items":{"type":"string"}},"result":{"type":"object"}}},"BeeswaxCampaignDto":{"type":"object","required":["active","advertiserId","buzzKey","campaignBudget","campaignId","campaignSpend","createDate","currency","dailyBudget","endDate","lastActive","name","oneworldCampaignId","oneworldCreatedByUserId","startDate","targetingType"],"properties":{"oneworldCampaignId":{"type":"integer","format":"int64"},"oneworldCreatedByUserId":{"type":"integer","format":"int64"},"targetingType":{"type":"string"},"campaignId":{"type":"integer","format":"int64"},"advertiserId":{"type":"integer","format":"int64"},"name":{"type":"string"},"campaignBudget":{"$ref":"#/definitions/Number"},"campaignSpend":{"$ref":"#/definitions/Number"},"dailyBudget":{"$ref":"#/definitions/Number"},"createDate":{"type":"string"},"startDate":{"type":"string"},"endDate":{"type":"string"},"lastActive":{"type":"string"},"currency":{"type":"string"},"buzzKey":{"type":"string"},"active":{"type":"boolean"}}},"BeeswaxCampaignRequest":{"type":"object","required":["accountId","campaignId","categoryIds","inventorySourceIds","rtkAdUnitIds","targetingType"],"properties":{"campaignId":{"type":"integer","format":"int64"},"accountId":{"type":"integer","format":"int64"},"targetingType":{"type":"string","enum":["DirectDeal","OpenOption"]},"rtkAdUnitIds":{"type":"array","items":{"type":"integer","format":"int64"}},"categoryIds":{"type":"array","items":{"type":"string"}},"inventorySourceIds":{"type":"array","items":{"type":"integer","format":"int64"}}}},"BeeswaxDirectDealPartnerEntity":{"type":"object","required":["adNetworks","adUnits","adUnitsAmount","partnerExternalId","partnerName"],"properties":{"partnerExternalId":{"type":"string"},"partnerName":{"type":"string"},"adUnits":{"type":"array","items":{"$ref":"#/definitions/AdUnitDto"}},"adUnitsAmount":{"type":"integer","format":"int64"},"adNetworks":{"type":"array","items":{"type":"string"}}}},"BeeswaxIdNameEntity":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}},"CampaignDto":{"type":"object","required":["advertiser","advertiserId","beeswaxCampaignIds","budget","categories","categoryIds","cpm","cpmType","created","dailyBudget","dailyLimit","editAction","end","expectedBudget","expectedCurrency","id","languages","maxAge","minAge","name","paymentApplicable","paymentStatus","placements","runUntilBudgetExhausted","sex","start","stats2system","status","type","updated","widgetCodes"],"properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"advertiserId":{"type":"integer","format":"int64"},"minAge":{"type":"integer","format":"int32"},"maxAge":{"type":"integer","format":"int32"},"sex":{"type":"string"},"languages":{"type":"array","items":{"type":"string"}},"categoryIds":{"type":"array","items":{"type":"integer","format":"int64"}},"categories":{"type":"array","items":{"$ref":"#/definitions/CategoryLocaleDto"}},"budget":{"type":"number"},"cpm":{"type":"number"},"cpmType":{"type":"string"},"dailyLimit":{"type":"boolean"},"runUntilBudgetExhausted":{"type":"boolean"},"dailyBudget":{"type":"number"},"status":{"type":"string"},"paymentStatus":{"type":"string"},"start":{"type":"string"},"end":{"type":"string"},"widgetCodes":{"type":"array","items":{"type":"string"}},"type":{"type":"string"},"paymentApplicable":{"type":"boolean"},"created":{"type":"string"},"updated":{"type":"string"},"advertiser":{"$ref":"#/definitions/AdvertiserDto"},"stats2system":{"type":"object","additionalProperties":{"$ref":"#/definitions/CampaignStatsDto"}},"beeswaxCampaignIds":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}},"expectedBudget":{"type":"number"},"expectedCurrency":{"type":"string"},"editAction":{"type":"string","enum":["CREATE","EDIT","REVIEW"]},"placements":{"type":"array","items":{"$ref":"#/definitions/CampaignTargetingGeoPlacementDto"}}}},"CampaignStatsDto":{"type":"object","required":["adAnswerClicks","adClick","averageCpm","bannerClicks","budget","budgetRemaining","budgetSpent","cpc","cpm","ctr","plannedImpressions","sharingClicks","totalClicks","totalViews"],"properties":{"budget":{"type":"number","format":"double"},"totalClicks":{"type":"integer","format":"int64"},"sharingClicks":{"type":"integer","format":"int64"},"adAnswerClicks":{"type":"integer","format":"int64"},"adClick":{"type":"integer","format":"int64"},"totalViews":{"type":"integer","format":"int64"},"bannerClicks":{"type":"integer","format":"int64"},"budgetSpent":{"type":"number","format":"double"},"budgetRemaining":{"type":"number","format":"double"},"cpm":{"type":"number","format":"double"},"averageCpm":{"type":"number","format":"double"},"plannedImpressions":{"type":"integer","format":"int64"},"ctr":{"type":"number","format":"double"},"cpc":{"type":"number","format":"double"}}},"CampaignTargetingGeoPlacementDto":{"type":"object","required":["campaignId","city","country","id","region"],"properties":{"id":{"type":"integer","format":"int64"},"country":{"$ref":"#/definitions/GeoCountryDto"},"region":{"$ref":"#/definitions/GeoRegionDto"},"city":{"$ref":"#/definitions/GeoCityDto"},"campaignId":{"type":"integer","format":"int64"}}},"Category":{"type":"object","required":["adnetworkCode","created","deleted","guid","icon","iconForPoll","id","imagesLoaded","status"],"properties":{"id":{"type":"integer","format":"int64"},"guid":{"type":"string"},"created":{"type":"string","format":"date-time"},"icon":{"type":"string","minLength":0,"maxLength":200},"iconForPoll":{"type":"string","minLength":0,"maxLength":200},"status":{"type":"string"},"deleted":{"type":"boolean"},"imagesLoaded":{"type":"boolean"},"adnetworkCode":{"type":"string"}}},"CategoryDto":{"type":"object","required":["deleted","imageLoaded","status"],"properties":{"id":{"type":"integer","format":"int64","description":"unique internal id of the category"},"guid":{"type":"string","description":"unique id, that could be used in frontend in links, etc."},"created":{"type":"integer","format":"int64","description":"creation timestamp"},"icon":{"type":"string","description":"http path to category icon"},"iconForPoll":{"type":"string","description":"http path to icon which is used for polls"},"status":{"type":"string"},"deleted":{"type":"boolean"},"imageLoaded":{"type":"boolean"},"adnetworkCode":{"type":"string","description":"IAB code which is mapped to Beeswax and other adUnit providers"},"categoryLocales":{"type":"object","description":"localized values, map that contains language code to locale object pairs","additionalProperties":{"$ref":"#/definitions/CategoryLocaleDto"}}},"description":"Category of the content"},"CategoryLocaleDto":{"type":"object","required":["adnetworkCode","category","created","description","icon","iconForPoll","id","imagesLoaded","locale","localeId","name","status"],"properties":{"id":{"type":"integer","format":"int64"},"localeId":{"type":"integer","format":"int64"},"locale":{"type":"string"},"status":{"type":"string"},"category":{"type":"integer","format":"int64"},"created":{"type":"string","format":"date-time"},"description":{"type":"string"},"name":{"type":"string"},"icon":{"type":"string"},"iconForPoll":{"type":"string"},"imagesLoaded":{"type":"boolean"},"adnetworkCode":{"type":"string"},"@id":{"type":"integer","format":"int32"}}},"ChargeDto":{"type":"object","required":["accountId","amount","currency","customerId","defaultCard","description","entityId","entityType","idempotencyKey","source","sourceType","userEmail"],"properties":{"accountId":{"type":"integer","format":"int64"},"userEmail":{"type":"string"},"entityId":{"type":"integer","format":"int64"},"entityType":{"type":"string","enum":["Campaign","Balance"]},"amount":{"type":"number"},"description":{"type":"string"},"source":{"type":"string"},"customerId":{"type":"string"},"defaultCard":{"type":"boolean"},"idempotencyKey":{"type":"string"},"sourceType":{"type":"string","enum":["InputCard","SavedCard"]},"currency":{"type":"string","enum":["USD","OneWorld"]}}},"GeoCityDto":{"type":"object","required":["cityName","countryCodeThreeLetter","countryCodeTwoLetter","geoname","id","metroCode","regionCode","regionName"],"properties":{"id":{"type":"integer","format":"int64"},"regionCode":{"type":"string"},"regionName":{"type":"string"},"countryCodeThreeLetter":{"type":"string"},"countryCodeTwoLetter":{"type":"string"},"metroCode":{"type":"string"},"geoname":{"type":"string"},"cityName":{"type":"string"}}},"GeoCountryDto":{"type":"object","required":["countryCodeThreeLetter","countryCodeTwoLetter","countryName","id"],"properties":{"id":{"type":"integer","format":"int64"},"countryCodeThreeLetter":{"type":"string"},"countryCodeTwoLetter":{"type":"string"},"countryName":{"type":"string"}}},"GeoRegionDto":{"type":"object","required":["countryCodeThreeLetter","countryCodeTwoLetter","id","regionCode","regionName"],"properties":{"id":{"type":"integer","format":"int64"},"regionCode":{"type":"string"},"regionName":{"type":"string"},"countryCodeThreeLetter":{"type":"string"},"countryCodeTwoLetter":{"type":"string"}}},"Number":{"type":"object"},"Optional":{"type":"object","required":["present"],"properties":{"present":{"type":"boolean"}}},"OptionalLong":{"type":"object","required":["present"],"properties":{"present":{"type":"boolean"}}},"PartnerParentDto":{"type":"object","required":["customerType","externalId","icon","name","protected"],"properties":{"externalId":{"type":"string"},"name":{"type":"string"},"icon":{"$ref":"#/definitions/AttachmentDto"},"customerType":{"type":"string"},"protected":{"type":"boolean"}}},"PartnerWithParentDetailsDto":{"type":"object","required":["accepted","acceptedBy","accounts","adStatus","apiAccess","apiKey","category","categoryId","contactEmail","contactName","contactPhone","createdBy","customerType","defaultLanguage","defaultTimeZone","domain","ehsPublisherId","externalId","id","importance","isAccepted","name","pageviews","parentObject","pricing","protected","redirectUrl","regionId","showAdStats","subdomain","tags","visits","widgetIcon"],"properties":{"id":{"type":"integer","format":"int64"},"externalId":{"type":"string"},"name":{"type":"string"},"widgetIcon":{"$ref":"#/definitions/AttachmentDto"},"adStatus":{"type":"string"},"redirectUrl":{"type":"string"},"apiKey":{"type":"string"},"accounts":{"type":"array","items":{"$ref":"#/definitions/AccountMinimalDto"}},"domain":{"type":"string"},"subdomain":{"type":"string"},"contactName":{"type":"string"},"contactPhone":{"type":"string"},"contactEmail":{"type":"string"},"defaultLanguage":{"type":"string"},"createdBy":{"$ref":"#/definitions/AccountMinimalDto"},"pricing":{"type":"string"},"isAccepted":{"type":"boolean"},"accepted":{"type":"integer","format":"int64"},"acceptedBy":{"$ref":"#/definitions/AccountMinimalDto"},"ehsPublisherId":{"type":"string"},"defaultTimeZone":{"type":"string"},"tags":{"type":"string"},"importance":{"type":"string"},"customerType":{"type":"string"},"categoryId":{"type":"integer","format":"int64"},"category":{"$ref":"#/definitions/Category"},"regionId":{"type":"integer","format":"int64"},"visits":{"type":"integer","format":"int64"},"pageviews":{"type":"integer","format":"int64"},"apiAccess":{"type":"string"},"parentObject":{"$ref":"#/definitions/PartnerParentDto"},"showAdStats":{"type":"boolean"},"protected":{"type":"boolean"}}},"PaymentCheckout":{"type":"object","required":["amount","currency","discountPcnt","error","invoiceAddress","invoiceAmount","invoiceCode","invoiceCurrency","invoiceType","key","minAmount","rate","status"],"properties":{"key":{"type":"string"},"error":{"type":"string"},"status":{"type":"string"},"currency":{"type":"string"},"amount":{"type":"number","format":"double"},"minAmount":{"type":"number","format":"double"},"invoiceType":{"type":"string","enum":["Crypto","Bank"]},"invoiceAddress":{"type":"string"},"invoiceCode":{"type":"integer","format":"int64"},"invoiceCurrency":{"type":"string"},"invoiceAmount":{"type":"number","format":"double"},"rate":{"type":"number","format":"double"},"discountPcnt":{"type":"number","format":"double"}}},"PaymentEntityDto":{"type":"object","required":["amount","balanceEntity","campaign","created","creator","currency","description","id","paymentSystem","paymentType","status","transactionAmount","transactionCurrency"],"properties":{"id":{"type":"integer","format":"int64"},"creator":{"$ref":"#/definitions/AccountMinimalDto"},"campaign":{"$ref":"#/definitions/CampaignDto"},"balanceEntity":{"$ref":"#/definitions/AccountBalanceDto"},"currency":{"type":"string"},"amount":{"type":"number"},"status":{"type":"string"},"description":{"type":"string"},"created":{"type":"string"},"paymentSystem":{"type":"string"},"paymentType":{"type":"string"},"transactionCurrency":{"type":"string"},"transactionAmount":{"type":"number"}}},"PaymentResponse":{"type":"object","required":["amount","currency","error","status","totalAmount"],"properties":{"error":{"type":"string"},"status":{"type":"string","enum":["succeeded","fail","undefined","AutoAccepted","Accepted"]},"currency":{"type":"string"},"amount":{"type":"number"},"totalAmount":{"type":"number"}}},"PollVoteDto":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","format":"int64"}}}}}