action callfire_get_text {
  label: "Find a specific text"
  description: "Returns a single Text instance for a given text id"
  provider: callfire
  method: GET
  path: "/texts/{id}"
  encoding: json
  input: {
    type: "object"
    properties: {
      fields: {
        type: "string"
      }
      id: {
        type: "integer"
        format: "int64"
      }
    }
    required: ["id"]
    additionalProperties: false
  }
  output: {
    type: "object"
    description: "Represents a text action sent or received by CallFire platform"
    properties: {
      attributes: {
        type: "object"
        description: "Map of user-defined string attributes associated with an action"
      }
      batchId: {
        type: "integer"
        format: "int64"
        description: "An id of contact batch associated with an action"
      }
      campaignId: {
        type: "integer"
        format: "int64"
        description: "An id of broadcast if given text was sent as a part of text broadcast"
      }
      contact: {
        type: "object"
        description: "Represents a contact in CallFire platform. Contains info about the people you want to contact. It allows you to store a user-defined properties for each contact"
        properties: {
          deleted: {
            type: "boolean"
            description: "A deleted contact, deleted contacts are hidden from search results"
          }
          externalId: {
            type: "string"
            description: "An external id of a contact for syncing with external sources"
          }
          externalSystem: {
            type: "string"
            description: "External system that external id refers to"
          }
          extraPhone1: {
            type: "string"
            description: "Phone number in E.164 format (11-digit). Example: 12132000384"
          }
          extraPhone2: {
            type: "string"
            description: "Phone number in E.164 format (11-digit). Example: 12132000384"
          }
          extraPhone3: {
            type: "string"
            description: "Phone number in E.164 format (11-digit). Example: 12132000384"
          }
          firstName: {
            type: "string"
            description: "A first name of a contact"
          }
          homePhone: {
            type: "string"
            description: "Phone number in E.164 format (11-digit). Example: 12132000384"
          }
          id: {
            type: "integer"
            format: "int64"
            description: "An id of a contact"
          }
          lastName: {
            type: "string"
            description: "A last name of a contact"
          }
          mobilePhone: {
            type: "string"
            description: "Phone number in E.164 format (11-digit). Example: 12132000384"
          }
          properties: {
            type: "object"
            description: "Map of user-defined string properties for contact"
          }
          workPhone: {
            type: "string"
            description: "Phone number in E.164 format (11-digit). Example: 12132000384"
          }
          zipcode: {
            type: "string"
            description: "A Zip code of a contact"
          }
        }
      }
      created: {
        type: "integer"
        format: "int64"
        description: "The time when the given resource was created, formatted in unix time milliseconds (read only). Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT"
      }
      finalTextResult: {
        type: "string"
        description: "Result of text (SENT, RECEIVED, DNT, TOO_BIG, INTERNAL_ERROR, CARRIER_ERROR, CARRIER_TEMP_ERROR, UNDIALED). See [call states and results](https://developers.callfire.com/results-responses-errors.html)"
        enum: ["SENT", "RECEIVED", "DNT", "TOO_BIG", "INTERNAL_ERROR", "CARRIER_ERROR", "CARRIER_TEMP_ERROR", "UNDIALED", "INVALID_NUMBER"]
      }
      fromNumber: {
        type: "string"
        description: "Sender's phone number in E.164 format (11-digit) or short code. Example: 12132000384, 67076"
      }
      id: {
        type: "integer"
        format: "int64"
        description: "An id of an action"
      }
      inbound: {
        type: "boolean"
        description: "An action inbound"
      }
      labels: {
        type: "array"
        description: "Labels associated with an action"
        items: {
          type: "string"
        }
      }
      media: {
        type: "array"
        description: "~"
        items: {
          type: "object"
          description: "Represents a media file which can be added to a text message"
          properties: {
            accountId: {
              type: "integer"
              format: "int64"
              description: "~"
            }
            created: {
              type: "integer"
              format: "int64"
              description: "The time when the given resource was created, formatted in unix time milliseconds (read only). Example: 1473781817000 "
            }
            id: {
              type: "integer"
              format: "int64"
              description: "An id of a media file"
            }
            lengthInBytes: {
              type: "integer"
              format: "int64"
              description: "A size of a media file in bytes"
            }
            mediaType: {
              type: "string"
              description: "A MIME type of media file, ex: image/jpeg, image/png, video/mp4, audio/mp3, etc"
            }
            name: {
              type: "string"
              description: "A name of a media file"
            }
            publicUrl: {
              type: "string"
              description: "A public URL of a media file"
            }
          }
        }
      }
      message: {
        type: "string"
        description: "A text message"
      }
      modified: {
        type: "integer"
        format: "int64"
        description: "The time when the given resource was modified, formatted in unix time milliseconds (read only). Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT"
      }
      records: {
        type: "array"
        description: "List of text records, each record contains additional details: time of sending, cost, current state.  A single contact may have multiple numbers. If given text was sent as part of broadcast with configured retry logic then each text record will contain details about attempted number"
        items: {
          type: "object"
          description: "Represents a text message sent to a contact's number"
          properties: {
            billedAmount: {
              type: "number"
              format: "float"
              description: "A cost of a sent text"
            }
            callerName: {
              type: "string"
              description: "~"
            }
            finishTime: {
              type: "integer"
              format: "int64"
              description: "A time when the given resource was updated, formatted in unix time milliseconds (read only). Example: 1473781817000"
            }
            id: {
              type: "integer"
              format: "int64"
              description: "An id of a text record"
            }
            labels: {
              type: "array"
              description: "Labels associated with a text action"
              items: {
                type: "string"
              }
            }
            message: {
              type: "string"
              description: "A text message"
            }
            switchId: {
              type: "string"
              description: "~"
            }
            textResult: {
              type: "string"
              description: "Result of a text (SENT, RECEIVED, DNT, TOO_BIG, INTERNAL_ERROR, CARRIER_ERROR, CARRIER_TEMP_ERROR, UNDIALED). See [call states and results](https://developers.callfire.com/results-responses-errors.html)"
              enum: ["SENT", "RECEIVED", "DNT", "TOO_BIG", "INTERNAL_ERROR", "CARRIER_ERROR", "CARRIER_TEMP_ERROR", "UNDIALED", "INVALID_NUMBER"]
            }
            toNumber: {
              type: "string"
              description: "An attempted phone number"
            }
          }
        }
      }
      state: {
        type: "string"
        description: "Current state of an action (READY, SELECTED, CALLBACK, DISABLED, FINISHED, DNC, DUP, INVALID, TIMEOUT, PERIOD_LIMIT). See [call states and results](https://developers.callfire.com/results-responses-errors.html)"
        enum: ["READY", "SELECTED", "CALLBACK", "FINISHED", "DISABLED", "SKIPPED", "DNC", "DUP", "INVALID", "TIMEOUT", "PERIOD_LIMIT", "RESTRICTED_NUMBER"]
      }
      toNumber: {
        type: "string"
        description: "Recipient's phone number in E.164 format (11-digit) or short code. Example: 12132000384, 67076"
      }
    }
  }
}