action callfire_get_delivery_reports {
  label: "Get delivery reports by ad hoc criteria"
  description: "Get delivery reports"
  provider: callfire
  method: GET
  path: "/reports/delivery"
  encoding: json
  input: {
    type: "object"
    properties: {
      campaignId: {
        type: "integer"
        format: "int64"
      }
      carrier: {
        type: "string"
      }
      deliveryCategory: {
        type: "string"
        enum: ["NO_DATA", "OPTED_OUT", "BOUNCED", "NO_CREDITS", "DELIVERED"]
      }
      deliveryState: {
        type: "string"
        enum: ["DELIVERED", "UNSENT_OPTED_OUT_GLOBAL", "UNSENT_OPTED_OUT_LOCAL", "UNSENT_NO_CREDITS", "GATEWAY_REJECTED", "CARRIER_REJECTED", "NOT_DELIVERED", "UNSENT_INVALID_NUMBER", "UNSENT_BAD_DATA", "UNSENT_FORCE_STOPPED", "UNSENT_PERIOD_LIMIT", "UNSENT_INTERNATIONAL", "UNSENT_INVALID_TIMEZONE_OR_DNC", "UNSENT_ALREADY_SCRUBBED", "UNSENT_SYSTEM_ERROR", "UNSENT_NO_WIRELESS_CARRIER", "UNSENT_MESSAGE_TOO_LONG", "UNSENT_MESSAGE_BLOCKED", "UNSENT_QUEUE_LIMIT_REACHED", "UNSENT_TOKEN_LIMIT_REACHED", "UNSENT_TIME_LIMIT_REACHED", "UNSENT_SCHEDULER_CAPACITY_EXCEEDED", "SPAM_DETECTED", "UNSENT_NO_GATEWAY", "UNSENT_DAILY_LIMIT_REACHED", "ORIGINATED", "SUBMITTED", "FORWARDED", "NOT_GIVEN", "UNKNOWN", "RETRY_MMS_AS_SMS", "QUEUED", "QUEUED_TRANSCODE", "ORIGINAL", "DUPE", "TRUNCATED", "REQUEUED_RATE_LIMITED", "BUFFERED", "RATE_LIMIT_EXCEEDED", "SERVICE_UNAVAILABLE", "SEND_MMS_AS_SMS", "REQUEUED_RECOVERABLE_ERROR", "SEND_WITH_ADDITIONAL_SPID", "UNSENT_FREE_TRIAL"]
      }
      endDate: {
        type: "string"
      }
      fromNumber: {
        type: "string"
      }
      limit: {
        type: "integer"
        format: "int32"
      }
      messageText: {
        type: "string"
      }
      offset: {
        type: "integer"
        format: "int32"
      }
      startDate: {
        type: "string"
      }
      toNumber: {
        type: "string"
      }
    }
    additionalProperties: false
  }
  output: {
    type: "object"
    description: "~"
    properties: {
      items: {
        type: "array"
        description: "~"
        items: {
          type: "object"
          description: "~"
          properties: {
            campaignId: {
              type: "integer"
              format: "int64"
              description: "~"
            }
            carrier: {
              type: "string"
              description: "~"
            }
            deliveryCategory: {
              type: "string"
              description: "~"
              enum: ["NO_DATA", "OPTED_OUT", "BOUNCED", "NO_CREDITS", "DELIVERED"]
            }
            deliveryState: {
              type: "string"
              description: "~"
              enum: ["DELIVERED", "UNSENT_OPTED_OUT_GLOBAL", "UNSENT_OPTED_OUT_LOCAL", "UNSENT_NO_CREDITS", "GATEWAY_REJECTED", "CARRIER_REJECTED", "NOT_DELIVERED", "UNSENT_INVALID_NUMBER", "UNSENT_BAD_DATA", "UNSENT_FORCE_STOPPED", "UNSENT_PERIOD_LIMIT", "UNSENT_INTERNATIONAL", "UNSENT_INVALID_TIMEZONE_OR_DNC", "UNSENT_ALREADY_SCRUBBED", "UNSENT_SYSTEM_ERROR", "UNSENT_NO_WIRELESS_CARRIER", "UNSENT_MESSAGE_TOO_LONG", "UNSENT_MESSAGE_BLOCKED", "UNSENT_QUEUE_LIMIT_REACHED", "UNSENT_TOKEN_LIMIT_REACHED", "UNSENT_TIME_LIMIT_REACHED", "UNSENT_SCHEDULER_CAPACITY_EXCEEDED", "SPAM_DETECTED", "UNSENT_NO_GATEWAY", "UNSENT_DAILY_LIMIT_REACHED", "ORIGINATED", "SUBMITTED", "FORWARDED", "NOT_GIVEN", "UNKNOWN", "RETRY_MMS_AS_SMS", "QUEUED", "QUEUED_TRANSCODE", "ORIGINAL", "DUPE", "TRUNCATED", "REQUEUED_RATE_LIMITED", "BUFFERED", "RATE_LIMIT_EXCEEDED", "SERVICE_UNAVAILABLE", "SEND_MMS_AS_SMS", "REQUEUED_RECOVERABLE_ERROR", "SEND_WITH_ADDITIONAL_SPID", "UNSENT_FREE_TRIAL"]
            }
            fromNumber: {
              type: "string"
              description: "~"
            }
            messageText: {
              type: "string"
              description: "~"
            }
            toNumber: {
              type: "string"
              description: "~"
            }
            updated: {
              type: "string"
              format: "date-time"
              description: "~"
            }
          }
        }
      }
      limit: {
        type: "integer"
        format: "int32"
        description: "~"
      }
      offset: {
        type: "integer"
        format: "int32"
        description: "~"
      }
      totalCount: {
        type: "integer"
        format: "int32"
        description: "~"
      }
    }
  }
}