post:
  operationId: PostGiftCards
  summary: Create a Gift Card
  description: >-
    Creates a Gift Card that can redeemed by its unique code. The Gift Card is
    only valid within 1 region.
  x-authenticated: true
  requestBody:
    content:
      application/json:
        schema:
          required:
            - region_id
          properties:
            value:
              type: integer
              description: The value (excluding VAT) that the Gift Card should represent.
            is_disabled:
              type: boolean
              description: >-
                Whether the Gift Card is disabled on creation. You will have to
                enable it later to make it available to Customers.
            ends_at:
              type: string
              format: date-time
              description: The time at which the Gift Card should no longer be available.
            region_id:
              description: The ID of the Region in which the Gift Card can be used.
              type: string
            metadata:
              description: >-
                An optional set of key-value pairs to hold additional
                information.
              type: object
  tags:
    - Gift Card
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            properties:
              gift_card:
                $ref: ../components/schemas/gift_card.yaml
get:
  operationId: GetGiftCards
  summary: List Gift Cards
  description: Retrieves a list of Gift Cards.
  x-authenticated: true
  parameters:
    - in: query
      name: offset
      description: The number of items to skip before the results.
      schema:
        type: number
        default: '0'
    - in: query
      name: limit
      description: Limit the number of items returned.
      schema:
        type: number
        default: '50'
    - in: query
      name: q
      description: a search term to search by code or display ID
      schema:
        type: string
  tags:
    - Gift Card
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            properties:
              gift_cards:
                type: array
                items:
                  $ref: ../components/schemas/gift_card.yaml
              count:
                type: integer
                description: The total number of items available
              offset:
                type: integer
                description: The number of items skipped before these items
              limit:
                type: integer
                description: The number of items per page