{"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/cloud:amazonaws-iot1click-devices/claim-devices-by-claim-code":{"post":{"operationId":"cloud_amazonaws_iot1click_devices_claim_devices_by_claim_code","summary":"Adds device(s) to your account (i.e., claim one or more devices) if and only if you received a claim code…","description":"PUT /claims/{claimCode}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["claimCode"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"claimCode":{"type":"string","description":"The claim code, starting with \"C-\", as provided by the device manufacturer."}}}}}},"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/cloud:amazonaws-iot1click-devices/describe-device":{"get":{"operationId":"cloud_amazonaws_iot1click_devices_describe_device","summary":"Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.","description":"GET /devices/{deviceId}","tags":["cloud"],"parameters":[{"name":"region","in":"query","required":false,"description":"The AWS region","schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"}},{"name":"deviceId","in":"query","required":true,"description":"The unique identifier of the device.","schema":{"type":"string","description":"The unique identifier of the device."}}],"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/cloud:amazonaws-iot1click-devices/finalize-device-claim":{"post":{"operationId":"cloud_amazonaws_iot1click_devices_finalize_device_claim","summary":"Given a device ID, finalizes the claim request for the associated device. Claiming a device consists of…","description":"PUT /devices/{deviceId}/finalize-claim","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["deviceId","body"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"deviceId":{"type":"string","description":"The unique identifier of the device."},"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":"byok"}},"/v1/cloud:amazonaws-iot1click-devices/get-device-methods":{"get":{"operationId":"cloud_amazonaws_iot1click_devices_get_device_methods","summary":"Given a device ID, returns the invokable methods associated with the device.","description":"GET /devices/{deviceId}/methods","tags":["cloud"],"parameters":[{"name":"region","in":"query","required":false,"description":"The AWS region","schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"}},{"name":"deviceId","in":"query","required":true,"description":"The unique identifier of the device.","schema":{"type":"string","description":"The unique identifier of the device."}}],"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/cloud:amazonaws-iot1click-devices/invoke-device-method":{"post":{"operationId":"cloud_amazonaws_iot1click_devices_invoke_device_method","summary":"Given a device ID, issues a request to invoke a named device method (with possible parameters). See the…","description":"POST /devices/{deviceId}/methods","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["deviceId","body"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"deviceId":{"type":"string","description":"The unique identifier of the device."},"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":"byok"}},"/v1/cloud:amazonaws-iot1click-devices/initiate-device-claim":{"post":{"operationId":"cloud_amazonaws_iot1click_devices_initiate_device_claim","summary":"Given a device ID, initiates a claim request for the associated device. Claiming a device consists of…","description":"PUT /devices/{deviceId}/initiate-claim","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["deviceId"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"deviceId":{"type":"string","description":"The unique identifier of the device."}}}}}},"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/cloud:amazonaws-iot1click-devices/list-device-events":{"get":{"operationId":"cloud_amazonaws_iot1click_devices_list_device_events","summary":"Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.","description":"GET /devices/{deviceId}/events","tags":["cloud"],"parameters":[{"name":"region","in":"query","required":false,"description":"The AWS region","schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"}},{"name":"deviceId","in":"query","required":true,"description":"The unique identifier of the device.","schema":{"type":"string","description":"The unique identifier of the device."}},{"name":"fromTimeStamp","in":"query","required":true,"description":"The start date for the device event query, in ISO8061 format. For example, 2018-03-28T15:45:12.880Z","schema":{"type":"string","description":"The start date for the device event query, in ISO8061 format. For example, 2018-03-28T15:45:12.880Z"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of results to return per request. If not set, a default value of 100 is used.","schema":{"type":"integer","description":"The maximum number of results to return per request. If not set, a default value of 100 is used."}},{"name":"nextToken","in":"query","required":false,"description":"The token to retrieve the next set of results.","schema":{"type":"string","description":"The token to retrieve the next set of results."}},{"name":"toTimeStamp","in":"query","required":true,"description":"The end date for the device event query, in ISO8061 format. For example, 2018-03-28T15:45:12.880Z","schema":{"type":"string","description":"The end date for the device event query, in ISO8061 format. For example, 2018-03-28T15:45:12.880Z"}}],"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/cloud:amazonaws-iot1click-devices/list-devices":{"get":{"operationId":"cloud_amazonaws_iot1click_devices_list_devices","summary":"Lists the 1-Click compatible devices associated with your AWS account.","description":"GET /devices","tags":["cloud"],"parameters":[{"name":"region","in":"query","required":false,"description":"The AWS region","schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"}},{"name":"deviceType","in":"query","required":false,"description":"The type of the device, such as \"button\".","schema":{"type":"string","description":"The type of the device, such as \"button\"."}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of results to return per request. If not set, a default value of 100 is used.","schema":{"type":"integer","description":"The maximum number of results to return per request. If not set, a default value of 100 is used."}},{"name":"nextToken","in":"query","required":false,"description":"The token to retrieve the next set of results.","schema":{"type":"string","description":"The token to retrieve the next set of results."}}],"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/cloud:amazonaws-iot1click-devices/list-tags-for-resource":{"get":{"operationId":"cloud_amazonaws_iot1click_devices_list_tags_for_resource","summary":"Lists the tags associated with the specified resource ARN.","description":"GET /tags/{resource-arn}","tags":["cloud"],"parameters":[{"name":"region","in":"query","required":false,"description":"The AWS region","schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"}},{"name":"resource-arn","in":"query","required":true,"description":"The ARN of the resource.","schema":{"type":"string","description":"The ARN of the 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/cloud:amazonaws-iot1click-devices/tag-resource":{"post":{"operationId":"cloud_amazonaws_iot1click_devices_tag_resource","summary":"Adds or updates the tags associated with the resource ARN. See AWS IoT 1-Click Service Limits for the…","description":"POST /tags/{resource-arn}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["resource-arn","body"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"resource-arn":{"type":"string","description":"The ARN of the resource."},"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":"byok"}},"/v1/cloud:amazonaws-iot1click-devices/unclaim-device":{"post":{"operationId":"cloud_amazonaws_iot1click_devices_unclaim_device","summary":"Disassociates a device from your AWS account using its device ID.","description":"PUT /devices/{deviceId}/unclaim","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["deviceId"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"deviceId":{"type":"string","description":"The unique identifier of the device."}}}}}},"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/cloud:amazonaws-iot1click-devices/untag-resource":{"post":{"operationId":"cloud_amazonaws_iot1click_devices_untag_resource","summary":"Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.","description":"DELETE /tags/{resource-arn}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["resource-arn","tagKeys"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"resource-arn":{"type":"string","description":"The ARN of the resource."},"tagKeys":{"type":"array","description":"A collections of tag keys. For example, {\"key1\",\"key2\"}"}}}}}},"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/cloud:amazonaws-iot1click-devices/update-device-state":{"post":{"operationId":"cloud_amazonaws_iot1click_devices_update_device_state","summary":"Using a Boolean value (true or false), this operation enables or disables the device given a device ID.","description":"PUT /devices/{deviceId}/state","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["deviceId","body"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"deviceId":{"type":"string","description":"The unique identifier of the device."},"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":"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"}}}}}}}