action callfire_get_number_lease_config {
  label: "Find a specific lease config"
  description: "Returns a single NumberConfig instance for a given number lease"
  provider: callfire
  method: GET
  path: "/numbers/leases/configs/{number}"
  encoding: json
  input: {
    type: "object"
    properties: {
      fields: {
        type: "string"
      }
      number: {
        type: "string"
      }
    }
    required: ["number"]
    additionalProperties: false
  }
  output: {
    type: "object"
    description: "Represents the configuration of a phone number purchased by user. You can configure number to accept inbound calls, play sounds to customer, make a transfer or setup an IVR script to interact with customer. See [CallFire IVR](https://www.callfire.com/products/ivr) for more info"
    properties: {
      callTrackingConfig: {
        type: "object"
        description: "Call tracking configuration allows you track incoming calls, analyze, respond to customers using sms or voice replies. For more information see [call tracking page](https://www.callfire.com/products/call-tracking)"
        properties: {
          failedTransferSoundId: {
            type: "integer"
            format: "int64"
            description: "An id of sound file, played if caller can not be connected to transfer number for any reason"
          }
          googleAnalytics: {
            type: "object"
            description: "Google Analytics for Call Tracking"
            properties: {
              category: {
                type: "string"
                description: "A category to group. For example: Sales or Support"
              }
              domain: {
                type: "string"
                description: "A domain name for analytics"
              }
              googleAccountId: {
                type: "string"
                description: "An id of a Google account, example: UA-XXXXX-2X"
              }
            }
          }
          introSoundId: {
            type: "integer"
            format: "int64"
            description: "An id of sound file, played if call is answered"
          }
          recorded: {
            type: "boolean"
            description: "Records all inbound calls"
          }
          screen: {
            type: "boolean"
            description: "Screens the incoming calls"
          }
          transferNumbers: {
            type: "array"
            description: "List of phone numbers in E.164 format (11-digit) are used for transfer. Example: 12132000384"
            items: {
              type: "string"
            }
          }
          voicemail: {
            type: "boolean"
            description: "Enables voicemail if call is not transferred"
          }
          voicemailSoundId: {
            type: "integer"
            format: "int64"
            description: "An id of sound file, played if voicemail is enabled and a call isn't transferred"
          }
          weeklySchedule: {
            type: "object"
            description: "Weekly schedule allows to schedule operations by day of week and time of the day"
            properties: {
              daysOfWeek: {
                type: "array"
                description: "A scheduled days when operation will trigger"
                items: {
                  type: "string"
                }
              }
              startTimeOfDay: {
                type: "object"
                description: "Represents a time part of a given date"
                properties: {
                  hour: {
                    type: "integer"
                    format: "int32"
                    description: "An hour of the day. Available values: 0-23"
                  }
                  minute: {
                    type: "integer"
                    format: "int32"
                    description: "The minutes. Available values: 0-59"
                  }
                  nano: {
                    type: "integer"
                    format: "int32"
                    description: "~"
                  }
                  second: {
                    type: "integer"
                    format: "int32"
                    description: "The seconds.  Available values: 0-59"
                  }
                }
              }
              stopTimeOfDay: {
                type: "object"
                additionalProperties: true
              }
              timeZone: {
                type: "string"
                description: "A user's timezone"
              }
            }
          }
          whisperSoundId: {
            type: "integer"
            format: "int64"
            description: "An id of sound file, played if call is screened"
          }
        }
      }
      configType: {
        type: "string"
        description: "A type of config. Available values: TRACKING, IVR"
        enum: ["IVR", "TRACKING"]
      }
      ivrInboundConfig: {
        type: "object"
        description: "~"
        properties: {
          dialplanXml: {
            type: "string"
            description: "~"
          }
        }
      }
      number: {
        type: "string"
        description: "Phone number in E.164 format (11-digit). Example: 12132000384"
      }
      textInboundConfig: {
        type: "object"
        description: "~"
        properties: {
          forwardEnabled: {
            type: "boolean"
            description: "~"
          }
          forwardNumber: {
            type: "string"
            description: "~"
          }
        }
      }
    }
  }
}