action pdfbroker_post_api_pdf_pdfwritestring {
  label: "Write text on a page in a pdf document."
  provider: pdfbroker
  method: POST
  path: "/api/pdf/pdfwritestring"
  encoding: json
  input: {
    type: "object"
    description: "The request dto object to write a string on pdf page"
    properties: {
      FontFileBase64String: {
        type: "string"
        description: "System fonts are available, but you can provide your own font file to be embedded in the pdf document. Send font as Base64 encoded string."
      }
      Options: {
        type: "object"
        description: "Options for writing string in pdf page;"
        properties: {
          Font: {
            type: "object"
            description: "The Font dto object"
            properties: {
              Name: {
                type: "string"
                description: "Gets the name of the font"
              }
              Size: {
                type: "number"
                format: "float"
                description: "Gets the size of the font"
              }
              Style: {
                type: "integer"
                format: "int32"
                description: "Font style enum representing Regular, Bold, Italic, BoldItalic"
                enum: [0, 1, 2, 3]
              }
            }
            additionalProperties: false
          }
          PageNumber: {
            type: "integer"
            format: "int32"
            description: "Get or set which page in the pdf to write on, default is first page."
          }
          Text: {
            type: "string"
            description: "The text to write in the pdf"
          }
          TextColor: {
            type: "object"
            description: "Set color"
            properties: {
              B: {
                type: "integer"
                format: "int32"
                description: "Get or sets B value of RGB color"
              }
              G: {
                type: "integer"
                format: "int32"
                description: "Get or sets G value of RGB color"
              }
              R: {
                type: "integer"
                format: "int32"
                description: "Get or sets R value of RGB color"
              }
            }
            additionalProperties: false
          }
          XOrigin: {
            type: "integer"
            format: "int32"
            enum: [0, 1, 2]
          }
          XPosition: {
            type: "number"
            format: "float"
            description: "Get or set the X axis position on where to write string, in reference to XOrigin."
          }
          YOrigin: {
            type: "integer"
            format: "int32"
            enum: [0, 1, 2]
          }
          YPosition: {
            type: "number"
            format: "float"
            description: "Get or set the Y axis position on where to write string, in reference to YOrigin."
          }
        }
        additionalProperties: false
      }
      PdfFileBase64String: {
        type: "string"
        description: "The pdf file to add text to, as Base64 encoded string."
      }
    }
    additionalProperties: false
  }
  output: {
    type: "object"
    description: "When setting the Accept-header in the request to \"application/json\" the content of the pdf file will be return as Base64 encoded string. Note that converting data to Base64 encoded strings increases the response size with approximately 33%, if you can accept the a binary format it's better to use Accept-header \"application/pdf\"."
    properties: {
      ErrorMessage: {
        type: "string"
        description: "If any error occurs the message will be displayed in here"
      }
      PdfFileBase64String: {
        type: "string"
        description: "The Base64 encoded string that is the pdf file."
      }
    }
    additionalProperties: false
  }
}