action callfire_create_contact_list {
  label: "Create contact lists"
  description: "Creates a contact list for use with campaigns using 1 of 3 inputs. A List of Contact objects, a list of String E.164 numbers, or a list of CallFire contactIds can be used as the data source for the created contact list. After contact list is added into the CallFire system, contact lists goes through seven system safeguards that check the accuracy and consistency of the data. For example, our system checks that contact number is formatted correctly, is valid, is not duplicated in another contact list, or is not added on a specific DNC list. You can configure to keep/merge or remove contacts which do not complies these rules. If contacts were not added to a contact list after the validation, this means the data needs to be properly formatted and corrected before calling this API"
  provider: callfire
  method: POST
  path: "/contacts/lists"
  encoding: json
  input: {
    type: "object"
    properties: {
      contactIds: {
        type: "array"
        description: "A list of ids of existing contacts in CallFire system"
        items: {
          type: "integer"
          format: "int64"
        }
      }
      contactNumbers: {
        type: "array"
        description: "List of numbers in E.164 format (11-digit). Example: 12132000384"
        items: {
          type: "string"
        }
      }
      contactNumbersField: {
        type: "string"
        description: "A type of a phone number (homePhone, workPhone, mobilePhone). This parameter is used with contactNumbers and specifies which types of phone numbers are included to a contact list"
      }
      contacts: {
        type: "array"
        description: "A list of new contact objects to be added"
        items: {
          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"
            }
          }
        }
      }
      fields: {
        type: "string"
      }
      name: {
        type: "string"
        description: "A name of a contact list"
      }
      useCustomFields: {
        type: "boolean"
        description: "A flag to indicate how to define property names for contacts. If true, uses the field and property names exactly as defined. If false will assign custom properties and fields to A, B, C, etc"
      }
    }
    additionalProperties: false
  }
  output: {
    type: "object"
    description: "Represents a contact list in CallFire system"
    properties: {
      created: {
        type: "integer"
        format: "int64"
        description: "A time when a given resource was created, formatted in unix time milliseconds (read only). Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT"
      }
      id: {
        type: "integer"
        format: "int64"
        description: "An Id of a contact list"
      }
      name: {
        type: "string"
        description: "A name of a contact list"
      }
      size: {
        type: "integer"
        format: "int32"
        description: "A number of contacts in a contact list"
      }
      status: {
        type: "string"
        description: "A current status of a contact list, available values: ACTIVE - contact list is ready, VALIDATING - contact list validation is in progress, IMPORTING - importing is in progress, IMPORT_FAILED - in case of errors occurred during the importing, ERRORS - contact list has validation errors, DELETED - contact list was deleted, PARSE_FAILED - contacts cannot be parsed, COLUMN_TOO_LARGE - if size of phone number or any other column exceeds 255 characters"
        enum: ["ACTIVE", "VALIDATING", "IMPORTING", "IMPORT_FAILED", "ERRORS", "DELETED", "PARSE_FAILED", "COLUMN_TOO_LARGE"]
      }
    }
  }
}