{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/entertainment:whapi-accounts/get-details":{"get":{"operationId":"entertainment_whapi_accounts_get_details","summary":"Retrieves details of a customers account","description":"GET /account","tags":["entertainment"],"parameters":[{"name":"apiKey","in":"query","required":true,"description":"A unique identifier of your application that is generated by the API portal.","schema":{"type":"string","description":"A unique identifier of your application that is generated by the API portal."}},{"name":"apiSecret","in":"query","required":true,"description":"Another unique identifier for your application.","schema":{"type":"string","description":"Another unique identifier for your application."}},{"name":"apiTicket","in":"query","required":true,"description":"Ticket Granting Ticket obtained from a previous request","schema":{"type":"string","description":"Ticket Granting Ticket obtained from a previous request"}},{"name":"fields","in":"query","required":false,"description":"Specify an absolute field list to return (Comma-Separated List)","schema":{"type":"array","description":"Specify an absolute field list to return (Comma-Separated List)"}},{"name":"include","in":"query","required":false,"description":"Specify fields in addition to the default to return (Comma-Separated List)","schema":{"type":"array","description":"Specify fields in addition to the default to return (Comma-Separated List)"}},{"name":"exclude","in":"query","required":false,"description":"Specify fields from the default to exclude (Comma-Separated List)","schema":{"type":"array","description":"Specify fields from the default to exclude (Comma-Separated List)"}},{"name":"territory","in":"query","required":false,"description":"Territory from which request originates","schema":{"type":"string","description":"Territory from which request originates"}},{"name":"languageAsPerTerritory","in":"query","required":false,"description":"Defines response field name language, true (default) returns in language defined by territory, false returns in English","schema":{"type":"string","default":true,"description":"Defines response field name language, true (default) returns in language defined by territory, false returns in English"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/entertainment:whapi-accounts/get-balance":{"get":{"operationId":"entertainment_whapi_accounts_get_balance","summary":"Get a customers account balance","description":"GET /account/balance","tags":["entertainment"],"parameters":[{"name":"apiKey","in":"query","required":true,"description":"A unique identifier of your application that is generated by the API portal.","schema":{"type":"string","description":"A unique identifier of your application that is generated by the API portal."}},{"name":"apiSecret","in":"query","required":true,"description":"Another unique identifier for your application.","schema":{"type":"string","description":"Another unique identifier for your application."}},{"name":"apiTicket","in":"query","required":true,"description":"Ticket Granting Ticket obtained from a previous request","schema":{"type":"string","description":"Ticket Granting Ticket obtained from a previous request"}},{"name":"fields","in":"query","required":false,"description":"Specify an absolute field list to return (Comma-Separated List)","schema":{"type":"array","description":"Specify an absolute field list to return (Comma-Separated List)"}},{"name":"include","in":"query","required":false,"description":"Specify fields in addition to the default to return (Comma-Separated List)","schema":{"type":"array","description":"Specify fields in addition to the default to return (Comma-Separated List)"}},{"name":"exclude","in":"query","required":false,"description":"Specify fields from the default to exclude (Comma-Separated List)","schema":{"type":"array","description":"Specify fields from the default to exclude (Comma-Separated List)"}},{"name":"territory","in":"query","required":false,"description":"Territory from which request originates","schema":{"type":"string","description":"Territory from which request originates"}},{"name":"languageAsPerTerritory","in":"query","required":false,"description":"Defines response field name language, true (default) returns in language defined by territory, false returns in English","schema":{"type":"string","default":true,"description":"Defines response field name language, true (default) returns in language defined by territory, false returns in English"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/entertainment:whapi-accounts/set-account-flags":{"post":{"operationId":"entertainment_whapi_accounts_set_account_flags","summary":"Sets a flag based on name to value provided for the user.","description":"POST /account/flags","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apiKey","apiSecret","apiTicket","body"],"properties":{"apiKey":{"type":"string","description":"A unique identifier of your application that is generated by the API portal."},"apiSecret":{"type":"string","description":"Another unique identifier for your application."},"apiTicket":{"type":"string","description":"Ticket Granting Ticket obtained from a previous request"},"apiCountryCode":{"type":"string","default":"GB","description":"A two-character ISO 3166-1-Alpha-2 code representing the country API to use."},"territory":{"type":"string","description":"Territory from which request originates"},"languageAsPerTerritory":{"type":"string","default":true,"description":"Defines response field name language, true (default) returns in language defined by territory, false returns in English"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/entertainment:whapi-accounts/get-payments":{"get":{"operationId":"entertainment_whapi_accounts_get_payments","summary":"Gets a customer's account payments","description":"GET /account/payments","tags":["entertainment"],"parameters":[{"name":"apiKey","in":"query","required":true,"description":"A unique identifier of your application that is generated by the API portal.","schema":{"type":"string","description":"A unique identifier of your application that is generated by the API portal."}},{"name":"apiSecret","in":"query","required":true,"description":"Another unique identifier for your application.","schema":{"type":"string","description":"Another unique identifier for your application."}},{"name":"apiTicket","in":"query","required":true,"description":"Ticket Granting Ticket obtained from a previous request","schema":{"type":"string","description":"Ticket Granting Ticket obtained from a previous request"}},{"name":"page","in":"query","required":false,"description":"The page number to return (Used with pageSize)","schema":{"type":"number","default":1,"description":"The page number to return (Used with pageSize)"}},{"name":"pageSize","in":"query","required":false,"description":"Specify the number of results to return per page.","schema":{"type":"number","default":100,"description":"Specify the number of results to return per page."}},{"name":"dateFrom","in":"query","required":false,"description":"The FROM datetime from payments to be returned. (yyyy-MM-ddTHH:mm:ss)","schema":{"type":"string","description":"The FROM datetime from payments to be returned. (yyyy-MM-ddTHH:mm:ss)"}},{"name":"dateTo","in":"query","required":false,"description":"The TO datetime for payments to be returned. (yyyy-MM-ddTHH:mm:ss)","schema":{"type":"string","description":"The TO datetime for payments to be returned. (yyyy-MM-ddTHH:mm:ss)"}},{"name":"sort","in":"query","required":false,"description":"The order the response will be retuned by. i.e. date,desc","schema":{"type":"string","default":"date,asc","description":"The order the response will be retuned by. i.e. date,desc"}},{"name":"transactionType","in":"query","required":false,"description":"Allows the user to select with they want to see withdrawls or deposits. If it is omitted from the query both types will be returned","schema":{"type":"string","description":"Allows the user to select with they want to see withdrawls or deposits. If it is omitted from the query both types will be returned"}},{"name":"fields","in":"query","required":false,"description":"Specify an absolute field list to return (Comma-Separated List)","schema":{"type":"array","description":"Specify an absolute field list to return (Comma-Separated List)"}},{"name":"include","in":"query","required":false,"description":"Specify fields in addition to the default to return (Comma-Separated List)","schema":{"type":"array","description":"Specify fields in addition to the default to return (Comma-Separated List)"}},{"name":"exclude","in":"query","required":false,"description":"Specify fields from the default to exclude (Comma-Separated List)","schema":{"type":"array","description":"Specify fields from the default to exclude (Comma-Separated List)"}},{"name":"territory","in":"query","required":false,"description":"Territory from which request originates","schema":{"type":"string","description":"Territory from which request originates"}},{"name":"languageAsPerTerritory","in":"query","required":false,"description":"Defines response field name language, true (default) returns in language defined by territory, false returns in English","schema":{"type":"string","default":true,"description":"Defines response field name language, true (default) returns in language defined by territory, false returns in English"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/entertainment:whapi-accounts/get-plus-card-details":{"get":{"operationId":"entertainment_whapi_accounts_get_plus_card_details","summary":"Gets a customer's plus card details if they exist.","description":"GET /account/plusCard","tags":["entertainment"],"parameters":[{"name":"apiKey","in":"query","required":true,"description":"A unique identifier of your application that is generated by the API portal.","schema":{"type":"string","description":"A unique identifier of your application that is generated by the API portal."}},{"name":"apiSecret","in":"query","required":true,"description":"Another unique identifier for your application.","schema":{"type":"string","description":"Another unique identifier for your application."}},{"name":"apiTicket","in":"query","required":true,"description":"Ticket Granting Ticket obtained from a previous request","schema":{"type":"string","description":"Ticket Granting Ticket obtained from a previous request"}},{"name":"fields","in":"query","required":false,"description":"Specify an absolute field list to return (Comma-Separated List)","schema":{"type":"array","description":"Specify an absolute field list to return (Comma-Separated List)"}},{"name":"include","in":"query","required":false,"description":"Specify fields in addition to the default to return (Comma-Separated List)","schema":{"type":"array","description":"Specify fields in addition to the default to return (Comma-Separated List)"}},{"name":"exclude","in":"query","required":false,"description":"Specify fields from the default to exclude (Comma-Separated List)","schema":{"type":"array","description":"Specify fields from the default to exclude (Comma-Separated List)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/entertainment:whapi-accounts/set-lost-stolen":{"post":{"operationId":"entertainment_whapi_accounts_set_lost_stolen","summary":"Sets a customer's plus card as Lost/Stolen","description":"POST /account/plusCard/lostStolen","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apiKey","apiSecret","apiTicket"],"properties":{"apiKey":{"type":"string","description":"A unique identifier of your application that is generated by the API portal."},"apiSecret":{"type":"string","description":"Another unique identifier for your application."},"apiTicket":{"type":"string","description":"Ticket Granting Ticket obtained from a previous request"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/entertainment:whapi-accounts/set-phone-number":{"post":{"operationId":"entertainment_whapi_accounts_set_phone_number","summary":"Sets a customer's plus card phone number","description":"POST /account/plusCard/phone/{oldPhoneNumber}","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apiKey","apiSecret","apiTicket","oldPhoneNumber","body"],"properties":{"apiKey":{"type":"string","description":"A unique identifier of your application that is generated by the API portal."},"apiSecret":{"type":"string","description":"Another unique identifier for your application."},"apiTicket":{"type":"string","description":"Ticket Granting Ticket obtained from a previous request"},"oldPhoneNumber":{"type":"string","description":"Old phone number to replace"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/entertainment:whapi-accounts/set-pin":{"post":{"operationId":"entertainment_whapi_accounts_set_pin","summary":"Sets a customer's plus card pin","description":"POST /account/plusCard/pin","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apiKey","apiSecret","apiTicket","body"],"properties":{"apiKey":{"type":"string","description":"A unique identifier of your application that is generated by the API portal."},"apiSecret":{"type":"string","description":"Another unique identifier for your application."},"apiTicket":{"type":"string","description":"Ticket Granting Ticket obtained from a previous request"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/entertainment:whapi-accounts/update-pin":{"post":{"operationId":"entertainment_whapi_accounts_update_pin","summary":"Updates a customer's plus card pin","description":"PUT /account/plusCard/pin","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apiKey","apiSecret","apiTicket","body"],"properties":{"apiKey":{"type":"string","description":"A unique identifier of your application that is generated by the API portal."},"apiSecret":{"type":"string","description":"Another unique identifier for your application."},"apiTicket":{"type":"string","description":"Ticket Granting Ticket obtained from a previous request"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}