action vtex_get_gift_list {
  label: "Get Gift List"
  description: "Retrieves information about a Gift List by its ID."
  provider: vtex
  method: GET
  path: "/api/addon/pvt/giftlist/get/{listId}"
  encoding: json
  input: {
    type: "object"
    properties: {
      Accept: {
        type: "string"
      }
      "Content-Type": {
        type: "string"
      }
      listId: {
        type: "integer"
      }
    }
    required: ["Accept", "Content-Type", "listId"]
    additionalProperties: false
  }
  output: {
    type: "object"
    description: "Object with information about the Gift List."
    properties: {
      IsPublic: {
        type: "boolean"
        description: "Defines if the gift list is public."
      }
      address: {
        type: "string"
        description: "Address of the gift list."
      }
      dateCreated: {
        type: "string"
        description: "Date when the gift list was created."
      }
      eventCity: {
        type: "string"
        description: "City of the event associated with the Gift List."
      }
      eventDate: {
        type: "string"
        description: "Date of the event associated with the Gift List."
      }
      eventLocation: {
        type: "string"
        description: "Location of the event associated with the Gift List."
      }
      eventState: {
        type: "string"
        description: "State of the event associated with the Gift List."
      }
      fileId: {
        type: "integer"
        description: "File ID."
      }
      fileUrl: {
        type: "string"
        description: "File URL."
      }
      giftCardId: {
        type: "integer"
        description: "Gift Card ID."
      }
      giftCardRechargeSkuId: {
        type: "integer"
        description: "ID of the SKU that recharges the gift card."
      }
      giftListId: {
        type: "integer"
        description: "Gift List ID."
      }
      giftListMembers: {
        type: "array"
        description: "Array of members of the gift list."
        items: {
          type: "object"
          description: "Object with information about each gift list member."
          properties: {
            clientId: {
              type: "string"
              description: "Client ID."
            }
            giftListId: {
              type: "integer"
              description: "Gift List ID."
            }
            giftListMemberId: {
              type: "integer"
              description: "Gift List member ID."
            }
            isActive: {
              type: "boolean"
              description: "Defines if the Gift List user is active or not."
            }
            isAdmin: {
              type: "boolean"
              description: "Defines if the Gift List member is an administrator of the Gift List or not."
            }
            name: {
              type: "string"
              description: "Name of the Gift List member."
            }
            surname: {
              type: "string"
              description: "Surname of the Gift List member."
            }
            text1: {
              type: "string"
              description: "Complementary text."
            }
            text2: {
              type: "string"
              description: "Complementary text."
            }
            title: {
              type: "string"
              description: "Title of the Gift List member."
            }
            userId: {
              type: "string"
              description: "User ID."
            }
          }
        }
      }
      giftListSkuIds: {
        type: "array"
        description: "Array with the IDs of SKUs that are part of the gift list."
        items: {
          type: "string"
          description: "SKU ID."
        }
      }
      giftListTypeId: {
        type: "integer"
        description: "Gift List Type ID."
      }
      giftListTypeName: {
        type: "string"
        description: "Gift List Type name."
      }
      isActive: {
        type: "boolean"
        description: "Defines if the gift list is active."
      }
      isAddressOk: {
        type: "boolean"
        description: "Validates the address of the gift list."
      }
      memberNames: {
        type: "string"
        description: "Name of the members of the gift list."
      }
      message: {
        type: "string"
        description: "Gift List message."
      }
      name: {
        type: "string"
        description: "Gift List name."
      }
      profileSystemUserAddressName: {
        type: "string"
        description: "Name of the user's address."
      }
      profileSystemUserId: {
        type: "string"
        description: "User ID on Profile System."
      }
      shipsToOwner: {
        type: "boolean"
        description: "Defines if items purchased from the gift list will be shipped to the owner of the gift list."
      }
      telemarketingId: {
        type: "integer"
        description: "Telemarketing ID."
      }
      telemarketingObservation: {
        type: "string"
        description: "Telemarketing observation."
      }
      urlFolder: {
        type: "string"
        description: "Slug of the gift list that will be part of its URL."
      }
      userId: {
        type: "string"
        description: "User ID."
      }
      version: {
        type: "integer"
        description: "Version of the gift list."
      }
    }
  }
}