functions

var GetCityDefinition = shell.SubstitutionFunction{
	Group:             "randomuser",
	Name:              "getcity",
	FunctionHelp:      "Get a random city of a consumer",
	Formats:           nil,
	OptionDescription: "",
	Options:           nil,
	Function:          GetCitySubstitute,
}

var GetDateDefinition = shell.SubstitutionFunction{
	Name:              "getdate",
	Group:             "date",
	FunctionHelp:      "Return formatted data value (default is now)",
	FormatDescription: "Format Parameter selects type of time:",
	Formats: []shell.SubstitutionItemHelp{
		shell.SubstitutionItemHelp{Item: "local", Description: "Display Local time value"},
		shell.SubstitutionItemHelp{Item: "utc", Description: "Display UTC time value"},
		shell.SubstitutionItemHelp{Item: "unix", Description: "Display Unix timestamp"},
	},
	OptionDescription: "Option is the Golang format for a date string",
	Options: []shell.SubstitutionItemHelp{
		shell.SubstitutionItemHelp{
			Item:        "2006-01-02 15:04:05",
			Description: "Default Golang format for date and time",
		},
		shell.SubstitutionItemHelp{
			Item:        "Mon",
			Description: "Example Golang format for day of week",
		},
		shell.SubstitutionItemHelp{
			Item:        "2006",
			Description: "Example Golang format for year",
		},
	},
	Function: GetDateSubstitute,
}

var GetEmailDefinition = shell.SubstitutionFunction{
	Group:             "randomuser",
	Name:              "getemail",
	FunctionHelp:      "Get a random email address of a consumer",
	Formats:           nil,
	OptionDescription: "",
	Options:           nil,
	Function:          GetEmailSubstitute,
}

var GetFirstNameDefinition = shell.SubstitutionFunction{
	Group:             "randomuser",
	Name:              "getfirstname",
	FunctionHelp:      "Get a random first name of a consumer",
	Formats:           nil,
	OptionDescription: "",
	Options:           nil,
	Function:          GetFirstNameSubstitute,
}

var GetLastNameDefinition = shell.SubstitutionFunction{
	Group:             "randomuser",
	Name:              "getlastname",
	FunctionHelp:      "Get a random last name of a consumer",
	Formats:           nil,
	OptionDescription: "",
	Options:           nil,
	Function:          GetLastNameSubstitute,
}

var GetPhoneDefinition = shell.SubstitutionFunction{
	Group:        "randomuser",
	Name:         "getphone",
	FunctionHelp: "Get a random phone number of a consumer",
	Formats: []shell.SubstitutionItemHelp{
		{"raw", "Raw unformatted phone number"},
		{"dots", "Format phone with periods"},
		{"dashes", "Format phone with dashes"},
	},
	OptionDescription: "",
	Options: []shell.SubstitutionItemHelp{
		{"main", "(Default) Provide the main phone number"},
		{"Cell", "Provide the cell phone number instead of main"},
	},
	Function: GetPhoneSubstitute,
}

var GetStateDefinition = shell.SubstitutionFunction{
	Group:        "randomuser",
	Name:         "getstate",
	FunctionHelp: "Get a random state of a consumer",
	Formats: []shell.SubstitutionItemHelp{
		{"default", "Full state name"},
		{"abbr", "Abbreviated state code"},
	},
	OptionDescription: "",
	Options:           nil,
	Function:          GetStateSubstitute,
}

var GetStreetDefinition = shell.SubstitutionFunction{
	Group:             "randomuser",
	Name:              "getstreet",
	FunctionHelp:      "Get a random street of a consumer",
	Formats:           nil,
	OptionDescription: "",
	Options:           nil,
	Function:          GetStreetSubstitute,
}

var GetZipDefinition = shell.SubstitutionFunction{
	Group:             "randomuser",
	Name:              "getzip",
	FunctionHelp:      "Get a random zip code of a consumer",
	Formats:           nil,
	OptionDescription: "",
	Options:           nil,
	Function:          GetZipSubstitute,
}

var ModifyDateDefinition = shell.SubstitutionFunction{
	Name:         "moddate",
	Group:        "date",
	FunctionHelp: "Modify current time by component (default to UTC)",
	Formats: []shell.SubstitutionItemHelp{
		shell.SubstitutionItemHelp{Item: "local", Description: "Default to Local time value"},
		shell.SubstitutionItemHelp{Item: "utc", Description: "Default to UTC time value"},
		shell.SubstitutionItemHelp{Item: "unix", Description: "Default to Unix time value 0"},
	},
	OptionDescription: "Modifications options (d=-2;s=+30;t=hns)",
	Options: []shell.SubstitutionItemHelp{
		shell.SubstitutionItemHelp{
			Item:        "s",
			Description: "Add the specified seconds to time",
		},
		shell.SubstitutionItemHelp{
			Item:        "n",
			Description: "Add the specified minutes to time",
		},
		shell.SubstitutionItemHelp{
			Item:        "h",
			Description: "Add the specified hours to time",
		},
		shell.SubstitutionItemHelp{
			Item:        "d",
			Description: "Add the specified days to date",
		},
		shell.SubstitutionItemHelp{
			Item:        "m",
			Description: "Add the specified months to date",
		},
		shell.SubstitutionItemHelp{
			Item:        "y",
			Description: "Add the specified years to the date",
		},
		shell.SubstitutionItemHelp{
			Item:        "t",
			Description: "Truncate date/time component(s) to minimum (t=ymdhns)",
		},
	},
	Function: ModifyDateSubstitute,
}

var NewGuidDefinition = shell.SubstitutionFunction{
	Name:              "newguid",
	Group:             "newguid",
	FunctionHelp:      "Generate a guid formated as specified",
	Formats:           nil,
	OptionDescription: "",
	Options:           nil,
	Function:          NewGuidSubstitute,
}

var NewIteratorDefinition = shell.SubstitutionFunction{
	Name:         "iterator",
	Group:        "iterator",
	FunctionHelp: "Return current value of a named (variable) iterator",
	Formats: []shell.SubstitutionItemHelp{
		{"varname", "Variable to be iterated"},
	},
	OptionDescription: "",
	Options: []shell.SubstitutionItemHelp{
		{"{increment}", "(Default = 1) Provide the integer increment"},
	},
	Function: NewIteratorSubstitute,
}

var Quote = shell.SubstitutionFunction{
	Name:         "quote",
	Group:        "quote",
	FunctionHelp: "Quote a variable",
	Formats: []shell.SubstitutionItemHelp{
		{"var", "Option is a variable name"},
	},
	OptionDescription: "",
	Options:           nil,
	Function:          QuoteSubstitute,
}

var SetDateDefinition = shell.SubstitutionFunction{
	Name:         "setdate",
	Group:        "date",
	FunctionHelp: "Set a date value equal to the option string (default to min date)",
	Formats: []shell.SubstitutionItemHelp{
		shell.SubstitutionItemHelp{Item: "local", Description: "Parse date as Local"},
		shell.SubstitutionItemHelp{Item: "utc", Description: "Parse date as UTC"},
		shell.SubstitutionItemHelp{Item: "unix", Description: "Parse date as Unix timestamp"},
	},
	OptionDescription: "The desired date formatted to format string",
	Options: []shell.SubstitutionItemHelp{
		shell.SubstitutionItemHelp{
			Item:        "2006-01-02T15:04:05",
			Description: "Default date format string",
		},
	},
	Function: SetDateSubstitute,
}

var ToLowerDefinition = shell.SubstitutionFunction{
	Name:         "tolower",
	Group:        "tolower",
	FunctionHelp: "Lower case an options parameter as identified by format",
	Formats: []shell.SubstitutionItemHelp{
		{"var", "Option is a variable name"},
	},
	OptionDescription: "",
	Options:           nil,
	Function:          ToLowerSubstitute,
}

var ToUpperDefinition = shell.SubstitutionFunction{
	Name:         "toupper",
	Group:        "toupper",
	FunctionHelp: "Upper case an options parameter as identified by format",
	Formats: []shell.SubstitutionItemHelp{
		{"var", "Option is a variable name"},
	},
	OptionDescription: "",
	Options:           nil,
	Function:          ToUpperSubstitute,
}