openapi: 3.2.0
info:
  title: Online Store Mailing Lists API
  version: '1.0'
  description: Online Store API
servers:
- url: https://www.yoursite.com/api/v1
  description: ''
security:
- X-AC-Auth-Token: []
tags:
- name: Mailing Lists
paths:
  /mailing_lists:
    get:
      summary: Get Mailing Lists
      tags:
      - Mailing Lists
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  mailing_lists:
                    type: array
                    items:
                      $ref: '#/components/schemas/mailing_lists'
      operationId: get-mailing_lists
      description: Gets an array of mailing lists.
    post:
      summary: Create a Mailing List
      operationId: post-mailing_lists
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mailing_lists'
      tags:
      - Mailing Lists
      description: Creates a mailing list.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  type: Internal
                  admin_list_name: InternalList
                  public_list_name: ''
                  store_id: 4
                  is_store_default: true
                  auto_opt_in: false
                  is_hidden: false
                  url_based_subscribe_url: ''
                  welcome_email_template_id: 0
              properties:
                type:
                  type: string
                admin_list_name:
                  type: string
                public_list_name:
                  type: string
                store_id:
                  type: integer
                is_store_default:
                  type: boolean
                auto_opt_in:
                  type: boolean
                is_hidden:
                  type: boolean
                url_based_subscribe_url:
                  type: string
                welcome_email_template_id:
                  type: integer
              required:
              - store_id
            examples:
              Example:
                value:
                  type: Internal
                  admin_list_name: InternalList
                  public_list_name: ''
                  store_id: 4
                  is_store_default: true
                  auto_opt_in: false
                  is_hidden: false
                  url_based_subscribe_url: ''
                  welcome_email_template_id: 0
  /mailing_lists/{id}:
    parameters:
    - schema:
        type: string
      name: id
      in: path
      required: true
      description: The ID of the `mailing_list`
    put:
      summary: Update a Mailing List
      operationId: put-maling_lists-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mailing_lists'
      tags:
      - Mailing Lists
      description: Updates a mailing list.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mailing_lists'
    delete:
      summary: Delete a Mailing List
      operationId: delete-maling_lists-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
      - Mailing Lists
      description: Deletes a mailing list.
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:
    mailing_lists:
      type: object
      properties:
        id:
          type: integer
        type:
          type: string
        admin_list_name:
          type: string
        public_list_name:
          type: string
        store_id:
          type: integer
        is_store_default:
          type: boolean
        auto_opt_in:
          type: boolean
        is_hidden:
          type: boolean
        url_based_subscribe_url:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
        welcome_email_template_id:
          type: string
  securitySchemes:
    X-AC-Auth-Token:
      name: X-AC-Auth-Token
      type: apiKey
      in: header