action vtex_get_api_catalog_pvt_attachments {
  label: "Get all attachments"
  description: "Retrieves information about all registered attachments. 
\n >⚠️ To understand the specific syntax for Assembly Options attachments, read the [Assembly Options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH#assembly-options-syntax) documentation. 
\n## Response body example
\n
\n```json
\n{
\n    \"Page\": 1,
\n    \"Size\": 11,
\n    \"TotalRows\": 11,
\n    \"TotalPage\": 1,
\n    \"Data\": [
\n        {
\n            \"Id\": 1,
\n            \"Name\": \"Acessórios do bicho\",
\n            \"IsRequired\": true,
\n            \"IsActive\": true,
\n            \"Domains\": [
\n                {
\n                    \"FieldName\": \"extra\",
\n                    \"MaxCaracters\": \"\",
\n                    \"DomainValues\": \"[0-3]#1[1-2][1]pricetable1;#3[0-2][0]pricetable2;#5[0-2][0]pricetable3\"
\n                }
\n            ]
\n        },
\n        {
\n            \"Id\": 2,
\n            \"Name\": \"Sobrenome\",
\n            \"IsRequired\": false,
\n            \"IsActive\": true,
\n            \"Domains\": []
\n        },
\n        {
\n            \"Id\": 3,
\n            \"Name\": \"Assinatura Teste\",
\n            \"IsRequired\": false,
\n            \"IsActive\": true,
\n            \"Domains\": [
\n                {
\n                    \"FieldName\": \" vtex.subscription.key.frequency\",
\n                    \"MaxCaracters\": \"\",
\n                    \"DomainValues\": \"1 day, 7 day, 1 month, 6 month\"
\n                },
\n                {
\n                    \"FieldName\": \"vtex.subscription.key.validity.begin\",
\n                    \"MaxCaracters\": \"\",
\n                    \"DomainValues\": \"1\"
\n                },
\n                {
\n                    \"FieldName\": \"vtex.subscription.key.validity.end\",
\n                    \"MaxCaracters\": \"\",
\n                    \"DomainValues\": \"31\"
\n                },
\n                {
\n                    \"FieldName\": \"vtex.subscription.key.purchaseday\",
\n                    \"MaxCaracters\": \"\",
\n                    \"DomainValues\": \"1, 2, 20, 31\"
\n                }
\n            ]
\n        },
\n        {
\n            \"Id\": 5,
\n            \"Name\": \"teste\",
\n            \"IsRequired\": false,
\n            \"IsActive\": true,
\n            \"Domains\": []
\n        },
\n        {
\n            \"Id\": 6,
\n            \"Name\": \"teste2\",
\n            \"IsRequired\": false,
\n            \"IsActive\": true,
\n            \"Domains\": []
\n        },
\n        {
\n            \"Id\": 7,
\n            \"Name\": \"vtex.subscription.teste3\",
\n            \"IsRequired\": false,
\n            \"IsActive\": true,
\n            \"Domains\": []
\n        },
\n        {
\n            \"Id\": 8,
\n            \"Name\": \"teste api nova\",
\n            \"IsRequired\": true,
\n            \"IsActive\": true,
\n            \"Domains\": [
\n                {
\n                    \"FieldName\": \"Basic teste\",
\n                    \"MaxCaracters\": \"\",
\n                    \"DomainValues\": \"[1-2]#9[1-1][1]basic;#11[0-1][1]basic\"
\n                },
\n                {
\n                    \"FieldName\": \"teste\",
\n                    \"MaxCaracters\": \"\",
\n                    \"DomainValues\": \"[0-10]#8[0-3][0]medium;#9[0-3][0]medium;#10[0-3][0]medium;#11[0-3][0]medium;#36[0-3][0]medium;#37[0-3][0]medium;#38[0-3][0]medium\"
\n                }
\n            ]
\n        },
\n        {
\n            \"Id\": 9,
\n            \"Name\": \"vtex.subscription.teste\",
\n            \"IsRequired\": false,
\n            \"IsActive\": true,
\n            \"Domains\": []
\n        },
\n        {
\n            \"Id\": 10,
\n            \"Name\": \"Montagens\",
\n            \"IsRequired\": false,
\n            \"IsActive\": true,
\n            \"Domains\": []
\n        },
\n        {
\n            \"Id\": 11,
\n            \"Name\": \"vtex.subscription.subscription\",
\n            \"IsRequired\": false,
\n            \"IsActive\": true,
\n            \"Domains\": [
\n                {
\n                    \"FieldName\": \"vtex.subscription.key.frequency\",
\n                    \"MaxCaracters\": \"15\",
\n                    \"DomainValues\": \"1 month\"
\n                },
\n                {
\n                    \"FieldName\": \"vtex.subscription.key.purchaseday\",
\n                    \"MaxCaracters\": \"15\",
\n                    \"DomainValues\": \"1,15,28\"
\n                }
\n            ]
\n        },
\n        {
\n            \"Id\": 12,
\n            \"Name\": \"T-Shirt Customization\",
\n            \"IsRequired\": false,
\n            \"IsActive\": true,
\n            \"Domains\": [
\n                {
\n                    \"FieldName\": \"T-Shirt Name\",
\n                    \"MaxCaracters\": \"15\",
\n                    \"DomainValues\": \"[]\"
\n                }
\n            ]
\n        }
\n    ]
\n}
\n```"
  provider: vtex
  method: GET
  path: "/api/catalog/pvt/attachments"
  encoding: json
  input: {
    type: "object"
    properties: {
      Accept: {
        type: "string"
      }
      "Content-Type": {
        type: "string"
      }
    }
    required: ["Accept", "Content-Type"]
    additionalProperties: false
  }
  output: {
    type: "object"
    properties: {
      Data: {
        type: "array"
        description: "Array containing attachments data."
        items: {
          type: "object"
          required: ["Id", "Name", "IsRequired", "IsActive", "Domains"]
          properties: {
            Domains: {
              type: "array"
              description: "List of characteristics related to the attachment."
              items: {
                type: "object"
                properties: {
                  DomainValues: {
                    type: "string"
                    description: "Allowed key values."
                  }
                  FieldName: {
                    type: "string"
                    description: "Attachment key name."
                  }
                  MaxCaracters: {
                    type: "string"
                    description: "Maximum number of characters in the attachment key."
                  }
                }
              }
            }
            Id: {
              type: "integer"
              description: "Attachment ID."
            }
            IsActive: {
              type: "boolean"
              description: "Defines if the attachment is active or not."
            }
            IsRequired: {
              type: "boolean"
              description: "Defines if the attachment is required or not."
            }
            Name: {
              type: "string"
              description: "Attachment Name."
            }
          }
        }
      }
      Page: {
        type: "integer"
        description: "Current page of results."
      }
      Size: {
        type: "integer"
        description: "Total number of results in the current page."
      }
      TotalPage: {
        type: "integer"
        description: "Total number of pages with results."
      }
      TotalRows: {
        type: "integer"
        description: "Total number of rows with results."
      }
    }
  }
}