{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:openchannel-market/get-apps":{"get":{"operationId":"open_data_openchannel_market_get_apps","summary":"Returns a paginated list of APPROVED or SUSPENDED apps","description":"GET /apps","tags":["open-data"],"parameters":[{"name":"query","in":"query","required":false,"description":"A query document. Example: {'name':'MyApp'} matches all the apps that have the name 'MyApp'","schema":{"type":"string","description":"A query document. Example: {'name':'MyApp'} matches all the apps that have the name 'MyApp'"}},{"name":"sort","in":"query","required":false,"description":"A sort document. Example: {'name':1} sorts the results by name in ascending order","schema":{"type":"string","description":"A sort document. Example: {'name':1} sorts the results by name in ascending order"}},{"name":"pageNumber","in":"query","required":false,"description":"The result set page number to be returned","schema":{"type":"integer","description":"The result set page number to be returned"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results to return per page","schema":{"type":"integer","description":"The maximum number of results to return per page"}},{"name":"userId","in":"query","required":false,"description":"The unique id of the user requesting this resource","schema":{"type":"string","description":"The unique id of the user requesting this resource"}},{"name":"isOwner","in":"query","required":false,"description":"Whether this result should only contain apps that are owned by this user","schema":{"type":"boolean","description":"Whether this result should only contain apps that are owned by this user"}}],"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":"byok"}},"/v1/open-data:openchannel-market/post-apps":{"post":{"operationId":"open_data_openchannel_market_post_apps","summary":"Adds a new app for this developer","description":"POST /apps","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["developerId","name"],"properties":{"developerId":{"type":"string","description":"The unique id of the developer that is adding this app"},"name":{"type":"string","description":"The name of the app"},"type":{"type":"string","description":"The type for this app"},"model":{"type":"string","description":"A JSON object representing the pricing model type for this app"},"customData":{"type":"string","description":"A custom JSON object that you can create and attach to this record"},"attributes":{"type":"string","description":"A custom set of app attributes defined by the administrator and attached to this app"},"restrict":{"type":"string","description":"JSON object to restrict users from owning or viewing this app. Example:…"},"allow":{"type":"string","description":"JSON object to restrict users from owning or viewing this app. Example:…"},"access":{"type":"string","description":"JSON array of data access requirements"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/get-apps-by-safe-name-safe-name":{"get":{"operationId":"open_data_openchannel_market_get_apps_by_safe_name_safe_name","summary":"Returns a single APPROVED or SUSPENDED app","description":"GET /apps/bySafeName/{safeName}","tags":["open-data"],"parameters":[{"name":"safeName","in":"query","required":true,"description":"The safeName of the App to be located","schema":{"type":"string","description":"The safeName of the App to be located"}},{"name":"userId","in":"query","required":false,"description":"The unique id of the user that is requesting this resource","schema":{"type":"string","description":"The unique id of the user that is requesting this resource"}},{"name":"trackViews","in":"query","required":false,"description":"Whether this call should be tracked as a 'view' for this app. Default is false.","schema":{"type":"boolean","description":"Whether this call should be tracked as a 'view' for this app. Default is false."}}],"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":"byok"}},"/v1/open-data:openchannel-market/get-apps-text-search":{"get":{"operationId":"open_data_openchannel_market_get_apps_text_search","summary":"Searches through the text of fields to find APPROVED or SUSPENDED apps","description":"GET /apps/textSearch","tags":["open-data"],"parameters":[{"name":"query","in":"query","required":false,"description":"A query document. Example: {'name':'MyApp'} matches all the documents that have the name 'MyApp'","schema":{"type":"string","description":"A query document. Example: {'name':'MyApp'} matches all the documents that have the name 'MyApp'"}},{"name":"text","in":"query","required":true,"description":"The text to search for.","schema":{"type":"string","description":"The text to search for."}},{"name":"fields","in":"query","required":true,"description":"A JSON array containing all the fields to be searched through. Example: ['name', 'customData.description']","schema":{"type":"string","description":"A JSON array containing all the fields to be searched through. Example: ['name', 'customData.description']"}},{"name":"pageNumber","in":"query","required":false,"description":"The result set page number to be returned","schema":{"type":"integer","description":"The result set page number to be returned"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results to return per page","schema":{"type":"integer","description":"The maximum number of results to return per page"}},{"name":"userId","in":"query","required":false,"description":"The unique id of the user requesting this resource","schema":{"type":"string","description":"The unique id of the user requesting this resource"}},{"name":"isOwned","in":"query","required":false,"description":"Whether this result should only contain apps that are owned by this user","schema":{"type":"boolean","description":"Whether this result should only contain apps that are owned by this user"}}],"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":"byok"}},"/v1/open-data:openchannel-market/get-apps-versions":{"get":{"operationId":"open_data_openchannel_market_get_apps_versions","summary":"Returns a paginated list of AppVersions","description":"GET /apps/versions","tags":["open-data"],"parameters":[{"name":"query","in":"query","required":false,"description":"A query document. Example: {'name':'MyApp'} matches all the apps that have the name 'MyApp'","schema":{"type":"string","description":"A query document. Example: {'name':'MyApp'} matches all the apps that have the name 'MyApp'"}},{"name":"sort","in":"query","required":false,"description":"A sort document. Example: {'name':1} sorts the results by name in ascending order","schema":{"type":"string","description":"A sort document. Example: {'name':1} sorts the results by name in ascending order"}},{"name":"pageNumber","in":"query","required":false,"description":"The result set page number to be returned","schema":{"type":"integer","description":"The result set page number to be returned"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results to return per page","schema":{"type":"integer","description":"The maximum number of results to return per page"}},{"name":"developerId","in":"query","required":false,"description":"The unique id of the developer requesting this resource","schema":{"type":"string","description":"The unique id of the developer requesting this resource"}}],"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":"byok"}},"/v1/open-data:openchannel-market/get-apps-app-id":{"get":{"operationId":"open_data_openchannel_market_get_apps_app_id","summary":"Returns a single APPROVED or SUSPENDED app","description":"GET /apps/{appId}","tags":["open-data"],"parameters":[{"name":"appId","in":"query","required":true,"description":"The id of the App to be located","schema":{"type":"string","description":"The id of the App to be located"}},{"name":"userId","in":"query","required":false,"description":"The unique id of the user that is requesting this resource","schema":{"type":"string","description":"The unique id of the user that is requesting this resource"}},{"name":"trackViews","in":"query","required":false,"description":"Whether this call should be tracked as a 'view' for this app. Default is false.","schema":{"type":"boolean","description":"Whether this call should be tracked as a 'view' for this app. Default is false."}}],"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":"byok"}},"/v1/open-data:openchannel-market/delete-apps-app-id":{"post":{"operationId":"open_data_openchannel_market_delete_apps_app_id","summary":"Removes app and all versions","description":"DELETE /apps/{appId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["appId","developerId"],"properties":{"appId":{"type":"string","description":"The id of the App to be removed"},"developerId":{"type":"string","description":"The unique id of the developer that is removing this app"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/post-apps-app-id-live":{"post":{"operationId":"open_data_openchannel_market_post_apps_app_id_live","summary":"Change the live app to another, previously approved version","description":"POST /apps/{appId}/live","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["appId","developerId","version"],"properties":{"appId":{"type":"string","description":"The id of the App to be changed"},"developerId":{"type":"string","description":"The unique id of the developer that is changing this AppVersion"},"version":{"type":"string","description":"The new version of the live App"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/post-apps-app-id-publish":{"post":{"operationId":"open_data_openchannel_market_post_apps_app_id_publish","summary":"Publishes the current working version of the app to the marketplace","description":"POST /apps/{appId}/publish","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["appId","developerId","version"],"properties":{"appId":{"type":"string","description":"The id of the app to be published"},"developerId":{"type":"string","description":"The unique id of the developer that is modifying this app"},"version":{"type":"integer","description":"The version of the app to be published"},"autoApprove":{"type":"boolean","description":"If true, this AppVersion is automatically approved and becomes immediately available to end users"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/get-apps-app-id-versions-version":{"get":{"operationId":"open_data_openchannel_market_get_apps_app_id_versions_version","summary":"Returns a single AppVersion","description":"GET /apps/{appId}/versions/{version}","tags":["open-data"],"parameters":[{"name":"appId","in":"query","required":true,"description":"The id of the App to be located","schema":{"type":"string","description":"The id of the App to be located"}},{"name":"version","in":"query","required":true,"description":"The version number of the app","schema":{"type":"integer","description":"The version number of the app"}},{"name":"developerId","in":"query","required":false,"description":"The unique id of the developer that is requesting this resource","schema":{"type":"string","description":"The unique id of the developer that is requesting this resource"}}],"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":"byok"}},"/v1/open-data:openchannel-market/post-apps-app-id-versions-version":{"post":{"operationId":"open_data_openchannel_market_post_apps_app_id_versions_version","summary":"Updates the app or creates a new version","description":"POST /apps/{appId}/versions/{version}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["appId","version","developerId"],"properties":{"appId":{"type":"string","description":"The id of the App to be updated"},"version":{"type":"string","description":"The version of the App to be updated"},"developerId":{"type":"string","description":"The unique id of the developer that is updating this app"},"name":{"type":"string","description":"The name of the app"},"type":{"type":"string","description":"The type for this app"},"model":{"type":"string","description":"A JSON object representing the pricing model type for this app"},"customData":{"type":"string","description":"A custom JSON object that you can create and attach to this record"},"attributes":{"type":"string","description":"A custom set of app attributes defined by the administrator and attached to this app"},"restrict":{"type":"string","description":"JSON object to restrict users from purchasing or viewing this app. Example:…"},"allow":{"type":"string","description":"JSON object to allow users to purchase or view this app. Example: {'purchase':{'country':['Canada','Mexico']}} allows only users from…"},"access":{"type":"string","description":"JSON array of data access requirements"},"approvalRequired":{"type":"string","description":"False if updates should skip the approval process and be available immediately. Default is True"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/patch-apps-app-id-versions-version":{"post":{"operationId":"open_data_openchannel_market_patch_apps_app_id_versions_version","summary":"Updates the app fields or creates a new version","description":"PATCH /apps/{appId}/versions/{version}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["appId","version","developerId"],"properties":{"appId":{"type":"string","description":"The id of the App to be updated"},"version":{"type":"string","description":"The version of the App to be updated"},"developerId":{"type":"string","description":"The unique id of the developer that is updating this app"},"name":{"type":"string","description":"The name of the app"},"type":{"type":"string","description":"The type for this app"},"model":{"type":"string","description":"A JSON object representing the pricing model type for this app"},"customData":{"type":"string","description":"A custom JSON object that you can create and attach to this record"},"attributes":{"type":"string","description":"A custom set of app attributes defined by the administrator and attached to this app"},"restrict":{"type":"string","description":"JSON object to restrict users from purchasing or viewing this app. Example:…"},"allow":{"type":"string","description":"JSON object to allow users to purchase or view this app. Example: {'purchase':{'country':['Canada','Mexico']}} allows only users from…"},"access":{"type":"string","description":"JSON array of data access requirements"},"approvalRequired":{"type":"string","description":"False if updates should skip the approval process and be available immediately. Default is True"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/delete-apps-app-id-versions-version":{"post":{"operationId":"open_data_openchannel_market_delete_apps_app_id_versions_version","summary":"Removes AppVersion","description":"DELETE /apps/{appId}/versions/{version}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["appId","version","developerId"],"properties":{"appId":{"type":"string","description":"The id of the App to be removed"},"version":{"type":"string","description":"The version of the App to be removed"},"developerId":{"type":"string","description":"The unique id of the developer that is removing this app"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/post-apps-app-id-versions-version-status":{"post":{"operationId":"open_data_openchannel_market_post_apps_app_id_versions_version_status","summary":"Allows a developer or administrator to change the status of apps","description":"POST /apps/{appId}/versions/{version}/status","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["appId","version"],"properties":{"appId":{"type":"string","description":"The id of the App to be updated"},"version":{"type":"integer","description":"The version of the App to be updated"},"developerId":{"type":"string","description":"The unique id of the developer that is modifying this app"},"status":{"type":"string","enum":["inReview","approved","suspended","rejected"],"description":"The new status for this app. Can be either 'inReview', 'approved', 'suspended' or 'rejected'"},"modifiedBy":{"type":"string","enum":["developer","administrator"],"default":"administrator","description":"The role initiating this status change. Can be either 'developer' or 'administrator' (default)"},"reason":{"type":"string","description":"The reason for this status change"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/post-custom-gateway-payment-ownership-id":{"post":{"operationId":"open_data_openchannel_market_post_custom_gateway_payment_ownership_id","summary":"Adds a payment for an app on behalf of a user","description":"POST /custom-gateway/payment/{ownershipId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ownershipId","amount"],"properties":{"ownershipId":{"type":"string","description":"The id of the ownership record involved in this transaction"},"amount":{"type":"integer","description":"The total amount paid in cents"},"date":{"type":"integer","description":"The date (in milliseconds) of when this payment was made"},"feeAmount":{"type":"integer","description":"The fee (in cents) paid to a payment processors or third parties to process this payment. Default is 0."},"marketplaceAmount":{"type":"integer","description":"The amount (in cents) paid to the marketplace owner as a commission for the purchase of this app. Defaults based on the commission amount…"},"developerAmount":{"type":"integer","description":"The amount (in cents) paid to the owner of the app. Defaults based on the commission amount configured for this marketplace."},"customData":{"type":"string","description":"A custom JSON object to attach to this transaction"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/post-custom-gateway-refund-ownership-id":{"post":{"operationId":"open_data_openchannel_market_post_custom_gateway_refund_ownership_id","summary":"Fully or partially refund payment for an app on behalf of a user","description":"POST /custom-gateway/refund/{ownershipId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ownershipId","amount"],"properties":{"ownershipId":{"type":"string","description":"The id of the ownership record involved in this transaction"},"amount":{"type":"integer","description":"The total amount refunded in cents"},"date":{"type":"integer","description":"The date (in milliseconds) of when this refund was made"},"feeAmount":{"type":"integer","description":"The fee (in cents) recovered from a payment processor or third party to process this payment. The default value is 0"},"marketplaceAmount":{"type":"integer","description":"The amount (in cents) recovered from the marketplace owner as a commission refund for the purchase of this app"},"developerAmount":{"type":"integer","description":"The amount (in cents) recovered from the owner of the app"},"customData":{"type":"string","description":"A custom JSON object to attach to this transaction"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/get-developer-accounts":{"get":{"operationId":"open_data_openchannel_market_get_developer_accounts","summary":"Returns a paginated list of developerAccounts","description":"GET /developerAccounts","tags":["open-data"],"parameters":[{"name":"query","in":"query","required":false,"description":"A query document. Example: {'name':'NASA'} matches all the developerAccounts that have the name 'NASA'","schema":{"type":"string","description":"A query document. Example: {'name':'NASA'} matches all the developerAccounts that have the name 'NASA'"}},{"name":"sort","in":"query","required":false,"description":"A sort document. Example: {'name':1} sorts the results by name in ascending order","schema":{"type":"string","description":"A sort document. Example: {'name':1} sorts the results by name in ascending order"}},{"name":"pageNumber","in":"query","required":false,"description":"The result set page number to be returned","schema":{"type":"integer","description":"The result set page number to be returned"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results to return per page","schema":{"type":"integer","description":"The maximum number of results to return per page"}}],"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":"byok"}},"/v1/open-data:openchannel-market/get-developer-accounts-developer-account-id":{"get":{"operationId":"open_data_openchannel_market_get_developer_accounts_developer_account_id","summary":"Returns a single developer account","description":"GET /developerAccounts/{developerAccountId}","tags":["open-data"],"parameters":[{"name":"developerAccountId","in":"query","required":true,"description":"The id of the developer account to be located","schema":{"type":"string","description":"The id of the developer account to be located"}}],"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":"byok"}},"/v1/open-data:openchannel-market/post-developer-accounts-developer-account-id":{"post":{"operationId":"open_data_openchannel_market_post_developer_accounts_developer_account_id","summary":"Updates the developer account or adds the developer account if it doesn't exist","description":"POST /developerAccounts/{developerAccountId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["developerAccountId","developerId"],"properties":{"developerAccountId":{"type":"string","description":"The id of the developer account to be updated"},"developerId":{"type":"string","description":"The id of the developer that this account belongs to"},"email":{"type":"string","description":"The contact email address"},"name":{"type":"string","description":"The name for the account"},"customData":{"type":"string","description":"A custom JSON object that you can create and attach to this record"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/patch-developer-accounts-developer-account-id":{"post":{"operationId":"open_data_openchannel_market_patch_developer_accounts_developer_account_id","summary":"Updates the developer account fields","description":"PATCH /developerAccounts/{developerAccountId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["developerAccountId","developerId"],"properties":{"developerAccountId":{"type":"string","description":"The id of the developer account to be updated"},"developerId":{"type":"string","description":"The id of the developer that this account belongs to"},"email":{"type":"string","description":"The contact email address"},"name":{"type":"string","description":"The name for the account"},"customData":{"type":"string","description":"A custom JSON object that you can create and attach to this record"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/delete-developer-accounts-developer-account-id":{"post":{"operationId":"open_data_openchannel_market_delete_developer_accounts_developer_account_id","summary":"Removes the developer account","description":"DELETE /developerAccounts/{developerAccountId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["developerAccountId"],"properties":{"developerAccountId":{"type":"string","description":"The id of the developer account to be updated"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/get-developers":{"get":{"operationId":"open_data_openchannel_market_get_developers","summary":"Returns a paginated list of developers","description":"GET /developers","tags":["open-data"],"parameters":[{"name":"query","in":"query","required":false,"description":"A query document. Example: {'name':'John'} matches all the developers that have the name 'John'","schema":{"type":"string","description":"A query document. Example: {'name':'John'} matches all the developers that have the name 'John'"}},{"name":"sort","in":"query","required":false,"description":"A sort document. Example: {'name':1} sorts the results by name in ascending order","schema":{"type":"string","description":"A sort document. Example: {'name':1} sorts the results by name in ascending order"}},{"name":"pageNumber","in":"query","required":false,"description":"The result set page number to be returned","schema":{"type":"integer","description":"The result set page number to be returned"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results to return per page","schema":{"type":"integer","description":"The maximum number of results to return per page"}}],"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":"byok"}},"/v1/open-data:openchannel-market/get-developers-developer-id":{"get":{"operationId":"open_data_openchannel_market_get_developers_developer_id","summary":"Returns a single developer","description":"GET /developers/{developerId}","tags":["open-data"],"parameters":[{"name":"developerId","in":"query","required":true,"description":"The id of the developer to be located","schema":{"type":"string","description":"The id of the developer to be located"}}],"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":"byok"}},"/v1/open-data:openchannel-market/post-developers-developer-id":{"post":{"operationId":"open_data_openchannel_market_post_developers_developer_id","summary":"Updates the developer record or adds the developer if it doesn't exist","description":"POST /developers/{developerId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["developerId"],"properties":{"developerId":{"type":"string","description":"The id of the developer to be located"},"type":{"type":"string","description":"The type for this developer"},"email":{"type":"string","description":"The developer's email"},"username":{"type":"string","description":"The developer's username"},"name":{"type":"string","description":"The developer's name"},"customData":{"type":"string","description":"A custom JSON object that you can create and attach to this record"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/patch-developers-developer-id":{"post":{"operationId":"open_data_openchannel_market_patch_developers_developer_id","summary":"Updates the developer fields","description":"PATCH /developers/{developerId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["developerId"],"properties":{"developerId":{"type":"string","description":"The id of the developer to be located"},"type":{"type":"string","description":"The type for this developer"},"email":{"type":"string","description":"The developer's email"},"username":{"type":"string","description":"The developer's username"},"name":{"type":"string","description":"The developer's name"},"customData":{"type":"string","description":"A custom JSON object that you can create and attach to this record"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/delete-developers-developer-id":{"post":{"operationId":"open_data_openchannel_market_delete_developers_developer_id","summary":"Removes a single developer","description":"DELETE /developers/{developerId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["developerId"],"properties":{"developerId":{"type":"string","description":"The id of the developer to be removed"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/get-events-event-id":{"get":{"operationId":"open_data_openchannel_market_get_events_event_id","summary":"Returns an event","description":"GET /events/{eventId}","tags":["open-data"],"parameters":[{"name":"eventId","in":"query","required":true,"description":"The id of the event","schema":{"type":"string","description":"The id of the event"}}],"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":"byok"}},"/v1/open-data:openchannel-market/get-files":{"get":{"operationId":"open_data_openchannel_market_get_files","summary":"Returns a paginated list of files","description":"GET /files","tags":["open-data"],"parameters":[{"name":"query","in":"query","required":false,"description":"A query document. Example: {'name':'file.txt'} matches all the files that have the name 'file.txt'","schema":{"type":"string","description":"A query document. Example: {'name':'file.txt'} matches all the files that have the name 'file.txt'"}},{"name":"sort","in":"query","required":false,"description":"A sort document. Example: {'name':1} sorts the results by name in ascending order","schema":{"type":"string","description":"A sort document. Example: {'name':1} sorts the results by name in ascending order"}},{"name":"pageNumber","in":"query","required":false,"description":"The result set page number to be returned","schema":{"type":"integer","description":"The result set page number to be returned"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results to return per page","schema":{"type":"integer","description":"The maximum number of results to return per page"}}],"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":"byok"}},"/v1/open-data:openchannel-market/post-files":{"post":{"operationId":"open_data_openchannel_market_post_files","summary":"Uploads a file.","description":"POST /files","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"isPrivate":{"type":"boolean","description":"If true, this file will be protected as a private file and require the generation of a signed URL in order to download using the Download…"},"hash":{"type":"string","description":"A comma separated list of hashes to return in order to verify file integrity."},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/get-files-by-id-or-url":{"get":{"operationId":"open_data_openchannel_market_get_files_by_id_or_url","summary":"Get the details for a file.","description":"GET /files/byIdOrUrl","tags":["open-data"],"parameters":[{"name":"fileIdOrUrl","in":"query","required":true,"description":"The fileId or fileUrl of the file to be returned","schema":{"type":"string","description":"The fileId or fileUrl of the file to be returned"}}],"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":"byok"}},"/v1/open-data:openchannel-market/get-files-download":{"get":{"operationId":"open_data_openchannel_market_get_files_download","summary":"A signed URL for downloading a private file can be returned by providing the fileId.","description":"GET /files/download","tags":["open-data"],"parameters":[{"name":"fileId","in":"query","required":true,"description":"The URL of the file to be uploaded","schema":{"type":"string","description":"The URL of the file to be uploaded"}},{"name":"validSeconds","in":"query","required":false,"description":"The number of seconds that this signed URL should be valid for. The default is 60.","schema":{"type":"integer","description":"The number of seconds that this signed URL should be valid for. The default is 60."}}],"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":"byok"}},"/v1/open-data:openchannel-market/post-files-url":{"post":{"operationId":"open_data_openchannel_market_post_files_url","summary":"Uploads a file from a URL","description":"POST /files/url","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"The URL of the file to be uploaded"},"isPrivate":{"type":"boolean","description":"If true, this file will be protected as a private file and require the generation of a signed URL in order to download using the Download…"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/get-markets-this":{"get":{"operationId":"open_data_openchannel_market_get_markets_this","summary":"Returns the current marketplace","description":"GET /markets/this","tags":["open-data"],"parameters":[],"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":"byok"}},"/v1/open-data:openchannel-market/get-ownership":{"get":{"operationId":"open_data_openchannel_market_get_ownership","summary":"Returns a paginated list of app licenses","description":"GET /ownership","tags":["open-data"],"parameters":[{"name":"query","in":"query","required":false,"description":"A query document. Example: {'userId':'12'} matches all the ownership records that have the userId '12'.","schema":{"type":"string","description":"A query document. Example: {'userId':'12'} matches all the ownership records that have the userId '12'."}},{"name":"sort","in":"query","required":false,"description":"A sort document. Example: {'date':1} sorts the results by date in ascending order","schema":{"type":"string","description":"A sort document. Example: {'date':1} sorts the results by date in ascending order"}},{"name":"pageNumber","in":"query","required":false,"description":"The result set page number to be returned","schema":{"type":"integer","description":"The result set page number to be returned"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results to return per page","schema":{"type":"integer","description":"The maximum number of results to return per page"}}],"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":"byok"}},"/v1/open-data:openchannel-market/post-ownership-install":{"post":{"operationId":"open_data_openchannel_market_post_ownership_install","summary":"Aquires an app license for a user (installs app)","description":"POST /ownership/install","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["appId","userId"],"properties":{"appId":{"type":"string","description":"The id of the App being owned"},"userId":{"type":"string","description":"The id of the User requesting to own the App"},"modelId":{"type":"string","description":"The id of the model associated with this ownership request"},"model":{"type":"string","description":"A custom model that will override the app's default model for this install"},"customData":{"type":"string","description":"A custom JSON object to attach to this ownership record"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/post-ownership-uninstall-ownership-id":{"post":{"operationId":"open_data_openchannel_market_post_ownership_uninstall_ownership_id","summary":"Uninstalls a license for a particular user and app (uninstalls app)","description":"POST /ownership/uninstall/{ownershipId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ownershipId","userId"],"properties":{"ownershipId":{"type":"string","description":"The id of the ownership to be unintalled"},"userId":{"type":"string","description":"The id of the User requesting to uninstall the App"},"cancelOwnership":{"type":"boolean","description":"True if this app will require payment to be re-installed. Default is false"},"customData":{"type":"string","description":"A custom JSON object to attach to this ownership record"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/get-ownership-ownership-id":{"get":{"operationId":"open_data_openchannel_market_get_ownership_ownership_id","summary":"Returns an ownership record","description":"GET /ownership/{ownershipId}","tags":["open-data"],"parameters":[{"name":"ownershipId","in":"query","required":true,"description":"The id belonging to the ownership record","schema":{"type":"string","description":"The id belonging to the ownership record"}}],"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":"byok"}},"/v1/open-data:openchannel-market/post-ownership-ownership-id":{"post":{"operationId":"open_data_openchannel_market_post_ownership_ownership_id","summary":"Updates an ownership record","description":"POST /ownership/{ownershipId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ownershipId"],"properties":{"ownershipId":{"type":"string","description":"The id of the ownership to be updated"},"customData":{"type":"string","description":"Custom JSON object that will be attached to this ownership record"},"expires":{"type":"integer","description":"The date (in millis) of when this app ownership expires"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/patch-ownership-ownership-id":{"post":{"operationId":"open_data_openchannel_market_patch_ownership_ownership_id","summary":"Updates ownership fields","description":"PATCH /ownership/{ownershipId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ownershipId"],"properties":{"ownershipId":{"type":"string","description":"The id of the ownership to be updated"},"customData":{"type":"string","description":"Custom JSON object that will be attached to this ownership record"},"expires":{"type":"integer","description":"The date (in millis) of when this app ownership expires"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/get-permission-apps-app-id":{"get":{"operationId":"open_data_openchannel_market_get_permission_apps_app_id","summary":"Returns permission that allows the app to access this user's data","description":"GET /permission/apps/{appId}","tags":["open-data"],"parameters":[{"name":"appId","in":"query","required":true,"description":"The id of the app","schema":{"type":"string","description":"The id of the app"}},{"name":"userId","in":"query","required":true,"description":"The id of the user","schema":{"type":"string","description":"The id of the user"}}],"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":"byok"}},"/v1/open-data:openchannel-market/post-permission-apps-app-id":{"post":{"operationId":"open_data_openchannel_market_post_permission_apps_app_id","summary":"Adds permission to allow the app to access this user's data","description":"POST /permission/apps/{appId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["appId","userId"],"properties":{"appId":{"type":"string","description":"The id of the app"},"userId":{"type":"string","description":"The id of the user"},"date":{"type":"integer","description":"The time (in milliseconds) of when the user agreed to the access request"},"ip":{"type":"string","description":"The ip address of the user agreeing to the access 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":"byok"}},"/v1/open-data:openchannel-market/delete-permission-apps-app-id":{"post":{"operationId":"open_data_openchannel_market_delete_permission_apps_app_id","summary":"Removes permission that allows the app to access this user's data","description":"DELETE /permission/apps/{appId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["appId","userId"],"properties":{"appId":{"type":"string","description":"The id of the app"},"userId":{"type":"string","description":"The id of the user"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/get-reviews":{"get":{"operationId":"open_data_openchannel_market_get_reviews","summary":"Find reviews for a particular App and marketplace. Results are automatically paginated when limit is set","description":"GET /reviews","tags":["open-data"],"parameters":[{"name":"query","in":"query","required":false,"description":"A query document. Example: {'rating': 500} matches all the reviews that have a rating of 500.","schema":{"type":"string","description":"A query document. Example: {'rating': 500} matches all the reviews that have a rating of 500."}},{"name":"sort","in":"query","required":false,"description":"A sort document. Example: {'rating':1} sorts the results by rating in ascending order","schema":{"type":"string","description":"A sort document. Example: {'rating':1} sorts the results by rating in ascending order"}},{"name":"pageNumber","in":"query","required":false,"description":"The result set page number to be returned","schema":{"type":"integer","description":"The result set page number to be returned"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results to return per page","schema":{"type":"integer","description":"The maximum number of results to return per page"}}],"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":"byok"}},"/v1/open-data:openchannel-market/post-reviews":{"post":{"operationId":"open_data_openchannel_market_post_reviews","summary":"Post a review from a User and returns the new post","description":"POST /reviews","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["appId","userId","headline","rating","description"],"properties":{"appId":{"type":"string","description":"The id of the App that will own this review"},"userId":{"type":"string","description":"The id of the User that is posting this review"},"userAccountId":{"type":"string","description":"The id of the User account that is posting this review"},"headline":{"type":"string","description":"The review's headline. Limited to 50 characters."},"rating":{"type":"integer","description":"The rating given within this review. The rating is represented as an integer between 0 and 500 (0 - 5 stars)"},"description":{"type":"string","description":"The review's description. Limited to 2000 characters."},"type":{"type":"string","description":"The type for this review"},"mustOwnApp":{"type":"boolean","description":"True if a review can be created only by a user that has owned the app. The default is True."},"autoApprove":{"type":"boolean","description":"True if the review should be automatically approved. The default is False."},"customData":{"type":"string","description":"A custom JSON object that you can create and attach to this record"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/get-reviews-review-id":{"get":{"operationId":"open_data_openchannel_market_get_reviews_review_id","summary":"Find a Review within a particular App and marketplace","description":"GET /reviews/{reviewId}","tags":["open-data"],"parameters":[{"name":"reviewId","in":"query","required":true,"description":"The id of the review to be located","schema":{"type":"string","description":"The id of the review to be located"}}],"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":"byok"}},"/v1/open-data:openchannel-market/post-reviews-review-id":{"post":{"operationId":"open_data_openchannel_market_post_reviews_review_id","summary":"Update a review from a User and returns the new post","description":"POST /reviews/{reviewId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["reviewId","userId","userAccountId","headline","rating","description"],"properties":{"reviewId":{"type":"string","description":"The id of the Review to be updated"},"userId":{"type":"string","description":"The id of the User that is updating this review"},"userAccountId":{"type":"string","description":"The id of the User account that is posting this review"},"headline":{"type":"string","description":"The review's headline. Limited to 50 characters."},"rating":{"type":"integer","description":"The rating given within this review. The rating is represented as an integer between 0 and 500 (0 - 5 stars)"},"description":{"type":"string","description":"The review's description. Limited to 2000 characters."},"customData":{"type":"string","description":"A custom JSON object that you can create and attach to this record"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/patch-reviews-review-id":{"post":{"operationId":"open_data_openchannel_market_patch_reviews_review_id","summary":"Update a review fields","description":"PATCH /reviews/{reviewId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["reviewId","userId"],"properties":{"reviewId":{"type":"string","description":"The id of the Review to be updated"},"userId":{"type":"string","description":"The id of the User that is updating this review"},"userAccountId":{"type":"string","description":"The id of the User account that is posting this review"},"headline":{"type":"string","description":"The review's headline. Limited to 50 characters."},"rating":{"type":"integer","description":"The rating given within this review. The rating is represented as an integer between 0 and 500 (0 - 5 stars)"},"description":{"type":"string","description":"The review's description. Limited to 2000 characters."},"customData":{"type":"string","description":"A custom JSON object that you can create and attach to this record"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/delete-reviews-review-id":{"post":{"operationId":"open_data_openchannel_market_delete_reviews_review_id","summary":"Remove a review","description":"DELETE /reviews/{reviewId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["reviewId","userId"],"properties":{"reviewId":{"type":"string","description":"The id of the Review to be updated"},"userId":{"type":"string","description":"The id of the User that is removing this review"},"userAccountId":{"type":"string","description":"The id of the User account that is emoving this review"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/post-stats-increment-field":{"post":{"operationId":"open_data_openchannel_market_post_stats_increment_field","summary":"Increments a statistics field","description":"POST /stats/increment/{field}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["field","appId"],"properties":{"field":{"type":"string","description":"The field to be incremented"},"appId":{"type":"string","description":"The id of the app associated with this statistic value"},"userId":{"type":"string","description":"The id of the user that is performing the action"},"value":{"type":"integer","description":"The increment amount. Default is 1 if no value is provided."},"date":{"type":"integer","description":"The date (in millis) for when this increment occurred. The default is the current date if no value is provided."}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/get-stats-series-period-fields":{"get":{"operationId":"open_data_openchannel_market_get_stats_series_period_fields","summary":"Return a timeseries for a particular field","description":"GET /stats/series/{period}/{fields}","tags":["open-data"],"parameters":[{"name":"period","in":"query","required":true,"description":"The period for the series (day or month)","schema":{"type":"string","enum":["day","month"],"description":"The period for the series (day or month)"}},{"name":"fields","in":"query","required":true,"description":"The field to be graphed. This also be a comma separated list of fields and the result will be a single timeseries containing the sum of…","schema":{"type":"string","description":"The field to be graphed. This also be a comma separated list of fields and the result will be a single timeseries containing the sum of…"}},{"name":"start","in":"query","required":false,"description":"The start date for this series (in millis)","schema":{"type":"integer","description":"The start date for this series (in millis)"}},{"name":"end","in":"query","required":false,"description":"The end date for this series (in millis)","schema":{"type":"integer","description":"The end date for this series (in millis)"}},{"name":"query","in":"query","required":false,"description":"A query document. Example: {'developerId': '112'} matches all the apps that have the developer with id 112","schema":{"type":"string","description":"A query document. Example: {'developerId': '112'} matches all the apps that have the developer with id 112"}}],"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":"byok"}},"/v1/open-data:openchannel-market/get-stats-total":{"get":{"operationId":"open_data_openchannel_market_get_stats_total","summary":"Returns the total number of events for a particular field.","description":"GET /stats/total","tags":["open-data"],"parameters":[{"name":"fields","in":"query","required":true,"description":"A comma seperated list of all the fields to be returned in the total (available by default: dislikes, likes, reviews, totalSales,…","schema":{"type":"string","description":"A comma seperated list of all the fields to be returned in the total (available by default: dislikes, likes, reviews, totalSales,…"}},{"name":"query","in":"query","required":false,"description":"A query document. Example: {'developerId': '112'} matches all the apps that have the developer with id 112","schema":{"type":"string","description":"A query document. Example: {'developerId': '112'} matches all the apps that have the developer with id 112"}},{"name":"start","in":"query","required":false,"description":"The start date for this total (in millis)","schema":{"type":"integer","description":"The start date for this total (in millis)"}},{"name":"end","in":"query","required":false,"description":"The end date for this total (in millis)","schema":{"type":"integer","description":"The end date for this total (in millis)"}}],"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":"byok"}},"/v1/open-data:openchannel-market/get-stripe-gateway-developer-developer-id-accounts":{"get":{"operationId":"open_data_openchannel_market_get_stripe_gateway_developer_developer_id_accounts","summary":"Returns a developers connected Stripe accounts","description":"GET /stripe-gateway/developer/{developerId}/accounts","tags":["open-data"],"parameters":[{"name":"developerId","in":"query","required":true,"description":"The id of the developer connecting their Stripe account","schema":{"type":"string","description":"The id of the developer connecting their Stripe account"}}],"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":"byok"}},"/v1/open-data:openchannel-market/post-stripe-gateway-developer-developer-id-accounts":{"post":{"operationId":"open_data_openchannel_market_post_stripe_gateway_developer_developer_id_accounts","summary":"Generate a temporary URL to allow a developer to connect their Stripe account","description":"POST /stripe-gateway/developer/{developerId}/accounts","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["developerId","redirectUrl"],"properties":{"developerId":{"type":"string","description":"The id of the developer connecting their Stripe account"},"redirectUrl":{"type":"string","description":"The URL to redirect this developer after they have connected their Stripe account"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/delete-stripe-gateway-developer-developer-id-accounts-stripe":{"post":{"operationId":"open_data_openchannel_market_delete_stripe_gateway_developer_developer_id_accounts_stripe","summary":"Disconnects a developer's Stripe account","description":"DELETE /stripe-gateway/developer/{developerId}/accounts/{stripeId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["developerId","stripeId"],"properties":{"developerId":{"type":"string","description":"The id of the developer disconnecting their Stripe account"},"stripeId":{"type":"string","description":"The id of the stripe account to disconnect"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/get-stripe-gateway-user-user-id-cards":{"get":{"operationId":"open_data_openchannel_market_get_stripe_gateway_user_user_id_cards","summary":"Returns credit cards for this user","description":"GET /stripe-gateway/user/{userId}/cards","tags":["open-data"],"parameters":[{"name":"userId","in":"query","required":true,"description":"The id of the user requesting their credit cards","schema":{"type":"string","description":"The id of the user requesting their credit cards"}}],"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":"byok"}},"/v1/open-data:openchannel-market/post-stripe-gateway-user-user-id-cards":{"post":{"operationId":"open_data_openchannel_market_post_stripe_gateway_user_user_id_cards","summary":"Adds credit card for this user","description":"POST /stripe-gateway/user/{userId}/cards","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userId","token"],"properties":{"userId":{"type":"string","description":"The id of the user adding their credit card"},"token":{"type":"string","description":"The Stripe token returned by the Stripe.js Stripe.card.createToken call"},"isDefault":{"type":"boolean","description":"Set to true if this should be set to be the default credit card"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/post-stripe-gateway-user-user-id-cards-card-id":{"post":{"operationId":"open_data_openchannel_market_post_stripe_gateway_user_user_id_cards_card_id","summary":"Updates a credit card for this user","description":"POST /stripe-gateway/user/{userId}/cards/{cardId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userId","cardId"],"properties":{"userId":{"type":"string","description":"The id of the user adding their credit card"},"cardId":{"type":"string","description":"The id of the card to be updated"},"isDefault":{"type":"boolean","description":"Set to true if this should be set to be the default credit card"},"address_city":{"type":"string","description":"The card holder's city"},"address_country":{"type":"string","description":"The card holder's country"},"address_line1":{"type":"string","description":"The card holder's street address"},"address_line2":{"type":"string","description":"The card holder's street address"},"address_state":{"type":"string","description":"The card holder's city state/province"},"address_zip":{"type":"string","description":"The card holder's zip/postal code"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/delete-stripe-gateway-user-user-id-cards-card-id":{"post":{"operationId":"open_data_openchannel_market_delete_stripe_gateway_user_user_id_cards_card_id","summary":"Removes a credit card for a user","description":"DELETE /stripe-gateway/user/{userId}/cards/{cardId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userId","cardId"],"properties":{"userId":{"type":"string","description":"The id of the user removing their credit card"},"cardId":{"type":"string","description":"The id of the credit card to remove"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/get-transactions":{"get":{"operationId":"open_data_openchannel_market_get_transactions","summary":"Returns a paginated list of transactions","description":"GET /transactions","tags":["open-data"],"parameters":[{"name":"query","in":"query","required":false,"description":"A query document. Example: {'userId':'1'} matches all the transactions that have the userId '1'.","schema":{"type":"string","description":"A query document. Example: {'userId':'1'} matches all the transactions that have the userId '1'."}},{"name":"sort","in":"query","required":false,"description":"A sort document. Example: {'date':1} sorts the results by total in ascending order","schema":{"type":"string","description":"A sort document. Example: {'date':1} sorts the results by total in ascending order"}},{"name":"pageNumber","in":"query","required":false,"description":"The result set page number to be returned","schema":{"type":"integer","description":"The result set page number to be returned"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results to return per page","schema":{"type":"integer","description":"The maximum number of results to return per page"}}],"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":"byok"}},"/v1/open-data:openchannel-market/get-transactions-transaction-id":{"get":{"operationId":"open_data_openchannel_market_get_transactions_transaction_id","summary":"Returns a transaction","description":"GET /transactions/{transactionId}","tags":["open-data"],"parameters":[{"name":"transactionId","in":"query","required":true,"description":"The id of the transaction to return","schema":{"type":"string","description":"The id of the transaction to return"}}],"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":"byok"}},"/v1/open-data:openchannel-market/post-transactions-transaction-id":{"post":{"operationId":"open_data_openchannel_market_post_transactions_transaction_id","summary":"Updates a transaction","description":"POST /transactions/{transactionId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["transactionId"],"properties":{"transactionId":{"type":"string","description":"The id of the transaction to be updated"},"customData":{"type":"string","description":"A custom JSON object that you can create and attach to this record"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/delete-transactions-transaction-id":{"post":{"operationId":"open_data_openchannel_market_delete_transactions_transaction_id","summary":"Deleted a transaction","description":"DELETE /transactions/{transactionId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["transactionId"],"properties":{"transactionId":{"type":"string","description":"The id of the transaction to be deleted"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/get-user-accounts":{"get":{"operationId":"open_data_openchannel_market_get_user_accounts","summary":"Returns a paginated list of userAccounts","description":"GET /userAccounts","tags":["open-data"],"parameters":[{"name":"query","in":"query","required":false,"description":"A query document. Example: {'name':'NASA'} matches all the userAccounts that have the name 'NASA'","schema":{"type":"string","description":"A query document. Example: {'name':'NASA'} matches all the userAccounts that have the name 'NASA'"}},{"name":"sort","in":"query","required":false,"description":"A sort document. Example: {'name':1} sorts the results by name in ascending order","schema":{"type":"string","description":"A sort document. Example: {'name':1} sorts the results by name in ascending order"}},{"name":"pageNumber","in":"query","required":false,"description":"The result set page number to be returned","schema":{"type":"integer","description":"The result set page number to be returned"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results to return per page","schema":{"type":"integer","description":"The maximum number of results to return per page"}}],"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":"byok"}},"/v1/open-data:openchannel-market/get-user-accounts-user-account-id":{"get":{"operationId":"open_data_openchannel_market_get_user_accounts_user_account_id","summary":"Returns a single user account","description":"GET /userAccounts/{userAccountId}","tags":["open-data"],"parameters":[{"name":"userAccountId","in":"query","required":true,"description":"The id of the user account to be located","schema":{"type":"string","description":"The id of the user account to be located"}}],"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":"byok"}},"/v1/open-data:openchannel-market/post-user-accounts-user-account-id":{"post":{"operationId":"open_data_openchannel_market_post_user_accounts_user_account_id","summary":"Updates the user account or adds the user account if it doesn't exist","description":"POST /userAccounts/{userAccountId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userAccountId","userId"],"properties":{"userAccountId":{"type":"string","description":"The id of the user account to be updated"},"userId":{"type":"string","description":"The Id of the user that this account belongs to"},"email":{"type":"string","description":"The contact email address"},"name":{"type":"string","description":"The user account name"},"customData":{"type":"string","description":"A custom JSON object that you can create and attach to this record"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/patch-user-accounts-user-account-id":{"post":{"operationId":"open_data_openchannel_market_patch_user_accounts_user_account_id","summary":"Updates the user account fields","description":"PATCH /userAccounts/{userAccountId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userAccountId","userId"],"properties":{"userAccountId":{"type":"string","description":"The id of the user account to be updated"},"userId":{"type":"string","description":"The Id of the user that this account belongs to"},"email":{"type":"string","description":"The contact email address"},"name":{"type":"string","description":"The user account name"},"customData":{"type":"string","description":"A custom JSON object that you can create and attach to this record"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/delete-user-accounts-user-account-id":{"post":{"operationId":"open_data_openchannel_market_delete_user_accounts_user_account_id","summary":"Removes the user account","description":"DELETE /userAccounts/{userAccountId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userAccountId"],"properties":{"userAccountId":{"type":"string","description":"The id of the user account to be removed"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/get-users":{"get":{"operationId":"open_data_openchannel_market_get_users","summary":"Returns a paginated list of users","description":"GET /users","tags":["open-data"],"parameters":[{"name":"query","in":"query","required":false,"description":"A query document. Example: {'name':'John'} matches all the users that have the name 'John'","schema":{"type":"string","description":"A query document. Example: {'name':'John'} matches all the users that have the name 'John'"}},{"name":"sort","in":"query","required":false,"description":"A sort document. Example: {'name':1} sorts the results by name in ascending order","schema":{"type":"string","description":"A sort document. Example: {'name':1} sorts the results by name in ascending order"}},{"name":"pageNumber","in":"query","required":false,"description":"The result set page number to be returned","schema":{"type":"integer","description":"The result set page number to be returned"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results to return per page","schema":{"type":"integer","description":"The maximum number of results to return per page"}}],"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":"byok"}},"/v1/open-data:openchannel-market/get-users-user-id":{"get":{"operationId":"open_data_openchannel_market_get_users_user_id","summary":"Return a single user","description":"GET /users/{userId}","tags":["open-data"],"parameters":[{"name":"userId","in":"query","required":true,"description":"The id of the user to be located","schema":{"type":"string","description":"The id of the user to be located"}}],"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":"byok"}},"/v1/open-data:openchannel-market/post-users-user-id":{"post":{"operationId":"open_data_openchannel_market_post_users_user_id","summary":"Updates a single user or adds the user if they don't exist","description":"POST /users/{userId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userId"],"properties":{"userId":{"type":"string","description":"The id of the user to be updated"},"type":{"type":"string","description":"The type for this user"},"email":{"type":"string","description":"The user's email"},"username":{"type":"string","description":"The user's username"},"name":{"type":"string","description":"The user's name"},"customData":{"type":"string","description":"A custom JSON object that you can create and attach to this record"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/patch-users-user-id":{"post":{"operationId":"open_data_openchannel_market_patch_users_user_id","summary":"Updates user fields","description":"PATCH /users/{userId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userId"],"properties":{"userId":{"type":"string","description":"The id of the user to be updated"},"type":{"type":"string","description":"The type for this user"},"email":{"type":"string","description":"The user's email"},"username":{"type":"string","description":"The user's username"},"name":{"type":"string","description":"The user's name"},"customData":{"type":"string","description":"A custom JSON object that you can create and attach to this record"}}}}}},"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":"byok"}},"/v1/open-data:openchannel-market/delete-users-user-id":{"post":{"operationId":"open_data_openchannel_market_delete_users_user_id","summary":"Removes a single user","description":"DELETE /users/{userId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userId"],"properties":{"userId":{"type":"string","description":"The id of the user to be removed"}}}}}},"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":"byok"}}},"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"}}}}}}}