Comunix Sunshine API

openapi: 3.2.0
info:
  title: Comunix Sunshine API
  version: '2026-10-10'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-10: 16 operation(s) read from 7 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Comunix has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 9
    documentation: 7
    pages-with-code: 6
    pages-read: 7
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-10'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://developer.zendesk.com/documentation/developer-tools/working-with-the-zendesk-apis/exploring-zendesk-apis-with-postman
  - https://developer.zendesk.com/documentation/ticketing/events/getting-started-with-events
  - https://developer.zendesk.com/documentation/ticketing/profiles/getting-started-with-profiles
  - https://developer.zendesk.com/documentation/custom-data/custom-objects/getting-started-with-custom-objects
  - https://developer.zendesk.com/documentation/developer-tools/getting-started/getting-a-trial-or-sponsored-account-for-development
  - https://developer.zendesk.com/api-reference/ticketing/introduction
  - https://developer.zendesk.com/api-reference/status_api/status_api
servers:
- url: https://status.zendesk.com
tags:
- name: Sunshine
paths:
  /api/sunshine/objects/records/{resourceId}/relationships/{relationshipTypeKey}:
    get:
      operationId: get_api_sunshine_objects_records_resourceId_relationships_relationshipTypeKey
      tags:
      - Sunshine
      summary: Getting started with legacy custom objects
      x-source: https://developer.zendesk.com/documentation/custom-data/custom-objects/getting-started-with-custom-objects
      parameters:
      - name: resourceId
        in: path
        required: true
        schema:
          type: string
      - name: relationshipTypeKey
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiSunshineObjectsRecordsResourceidRelationshipsRelations'
      x-evidence:
        kind: documentation
  /api/sunshine/objects/{objectid}:
    post:
      operationId: post_api_sunshine_objects_objectid
      tags:
      - Sunshine
      summary: Getting started with legacy custom objects
      x-source: https://developer.zendesk.com/documentation/custom-data/custom-objects/getting-started-with-custom-objects
      parameters:
      - name: objectid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiSunshineObjectsObjectidRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiSunshineObjectsObjectidResponse'
      x-evidence:
        kind: documentation
        collapsed_from: 2 example path(s) differing only at objectId
  /api/sunshine/{sunshineid}/records:
    post:
      operationId: post_api_sunshine_sunshineid_records
      tags:
      - Sunshine
      summary: Getting started with legacy custom objects
      x-source: https://developer.zendesk.com/documentation/custom-data/custom-objects/getting-started-with-custom-objects
      parameters:
      - name: sunshineid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiSunshineSunshineidRecordsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiSunshineSunshineidRecordsResponse'
      x-evidence:
        kind: documentation
        collapsed_from: 2 example path(s) differing only at sunshineId
  /api/sunshine/{sunshineid}/types:
    post:
      operationId: post_api_sunshine_sunshineid_types
      tags:
      - Sunshine
      summary: Getting started with legacy custom objects
      x-source: https://developer.zendesk.com/documentation/custom-data/custom-objects/getting-started-with-custom-objects
      parameters:
      - name: sunshineid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiSunshineSunshineidTypesRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiSunshineSunshineidTypesResponse'
      x-evidence:
        kind: documentation
        collapsed_from: 2 example path(s) differing only at sunshineId
components:
  schemas:
    PostApiSunshineSunshineidTypesResponse:
      type: object
      properties:
        data.key:
          type: string
          description: Key of the created object type
        data.schema:
          type: object
          description: Schema of the created object type
        data.created_at:
          type: string
          description: Timestamp of creation
        data.updated_at:
          type: string
          description: Timestamp of last update
    PostApiSunshineSunshineidTypesRequest:
      type: object
      properties:
        data:
          type: object
          description: Contains the key and schema for the legacy object type
        data.key:
          type: string
          description: Unique identifier for the object type (e.g., "pc")
        data.schema:
          type: object
          description: Schema describing the object's properties
        data.schema.properties:
          type: object
          description: Map of property definitions
        data.schema.properties.id:
          type: object
          description: Property definition for id
        data.schema.properties.id.type:
          type: string
          description: Data type, e.g., "string"
        data.schema.properties.id.description:
          type: string
          description: Description of the id property
        data.schema.properties.model:
          type: object
          description: Property definition for model
        data.schema.properties.is_laptop:
          type: object
          description: Property definition for is_laptop
        data.schema.required:
          type: array
          description: List of required property names
      required:
      - data
      - data.key
      - data.schema
      - data.schema.properties
    PostApiSunshineObjectsObjectidResponse:
      type: object
      properties:
        data.type:
          type: string
          description: Object type
        data.id:
          type: string
          description: Legacy object record id
    GetApiSunshineObjectsRecordsResourceidRelationshipsRelations:
      type: object
      properties:
        data:
          type: array
          description: List of relationship records
        data.id:
          type: string
          description: Relationship record id
        data.target:
          type: string
          description: Target object reference
        data.ref:
          type: string
          description: API reference URL for the target
        links.previous:
          type: string
          description: Link to previous page (if any)
        links.next:
          type: string
          description: Link to next page (if any)
    PostApiSunshineSunshineidRecordsRequest:
      type: object
      properties:
        data:
          type: object
          description: Defines the relationship record
        data.relationship_type:
          type: string
          description: Key of the relationship type
        data.source:
          type: string
          description: ID of the source object
        data.target:
          type: string
          description: 'ID of the target object (may include zen: prefix)'
      required:
      - data
      - data.relationship_type
      - data.source
      - data.target
    PostApiSunshineSunshineidRecordsResponse:
      type: object
      properties:
        data.id:
          type: string
          description: Relationship record id
        data.relationship_record_type:
          type: string
          description: Relationship type key
        data.source:
          type: string
          description: Source object id
        data.target:
          type: string
          description: Target object id
        data.created_at:
          type: string
          description: Timestamp of creation
    PostApiSunshineObjectsObjectidRequest:
      type: object
      properties:
        data:
          type: object
          description: Contains the type and attributes for the record
        data.type:
          type: string
          description: Object type key (e.g., "pc")
        data.attributes:
          type: object
          description: Attributes defined by the object type schema
        data.attributes.id:
          type: string
          description: Custom identifier for the object
        data.attributes.model:
          type: string
          description: Model of the object
        data.attributes.is_laptop:
          type: boolean
          description: Whether the object is a laptop
      required:
      - data
      - data.type
      - data.attributes