openapi: 3.2.0
info:
  title: Online Store Notifications API
  version: '1.0'
  description: Online Store API
servers:
- url: https://www.yoursite.com/api/v1
  description: ''
security:
- X-AC-Auth-Token: []
tags:
- name: Notifications
paths:
  /notifications:
    get:
      summary: Get Notifications
      tags:
      - Notifications
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  notifications:
                    type: array
                    items:
                      $ref: '#/components/schemas/notifications'
      operationId: get-notifications
      description: 'Returns an array of product notifications. '
    post:
      summary: Create a Notification
      operationId: post-notifications
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notifications'
      tags:
      - Notifications
      description: Creates a product notification.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  product_id: 86
                  email_address: test@mail.com
                  customer_id: 22
                  notification_frequency_type: Once
                  store_id: 1
                  variant_inventory_id: null
              properties:
                product_id:
                  type: integer
                email_address:
                  type: string
                customer_id:
                  type: integer
                notification_frequency_type:
                  type: string
                store_id:
                  type: integer
                variant_inventory_id:
                  type: integer
            examples:
              Example:
                value:
                  product_id: 86
                  email_address: test@cart.com
                  customer_id: 22
                  notification_frequency_type: Once
                  store_id: 1
                  variant_inventory_id: 123
  /notifications/{id}:
    parameters:
    - schema:
        type: string
      name: id
      in: path
      required: true
      description: The ID of the `notification`
    put:
      summary: Update a Notification
      operationId: put-notifications-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notifications'
      tags:
      - Notifications
      description: Updates a product notification.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/notifications'
        description: ''
    delete:
      summary: Delete a Notification
      operationId: delete-notifications-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
      - Notifications
      description: Deletes a notificaton.
components:
  responses:
    '404':
      description: Resource Not Found
      content:
        application/json:
          schema:
            description: Not Found
            type: object
            x-examples:
              example-1:
                status_code: 404
                message: Not Found
                details: No resource found
            properties:
              status_code:
                type: number
              message:
                type: string
              details:
                type: string
          examples: {}
      headers: {}
  schemas:
    notifications:
      type: object
      properties:
        notification_id:
          type: integer
        product_id:
          type: integer
        email_address:
          type: string
        customer_id:
          type: integer
        notification_frequency_type:
          type: string
        store_id:
          type: integer
        variant_inventory_id:
          type: integer
  securitySchemes:
    X-AC-Auth-Token:
      name: X-AC-Auth-Token
      type: apiKey
      in: header