PHP Classes Generated from Force.com Metadata API WSDL
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?php | |
// Avoid clashes with classes defined in SforceHeaderOptions.php | |
namespace metadata; | |
// PHP classes corresponding to the data types in defined in WSDL | |
class checkDeployStatus { | |
/** | |
* @var string | |
* NOTE: asyncProcessId should follow the following restrictions | |
* The value length should be | |
* 18 | |
* The pattern should be | |
* [a-zA-Z0-9]{18} | |
*/ | |
public $asyncProcessId; | |
} | |
class checkDeployStatusResponse { | |
/** | |
* @var (object)DeployResult | |
*/ | |
public $result; | |
} | |
class DeployResult { | |
/** | |
* @var string | |
* NOTE: id should follow the following restrictions | |
* The value length should be | |
* 18 | |
* The pattern should be | |
* [a-zA-Z0-9]{18} | |
*/ | |
public $id; | |
/** | |
* @var array[0, unbounded] of (object)DeployMessage | |
*/ | |
public $messages; | |
/** | |
* @var (object)RetrieveResult | |
*/ | |
public $retrieveResult; | |
/** | |
* @var (object)RunTestsResult | |
*/ | |
public $runTestResult; | |
/** | |
* @var boolean | |
*/ | |
public $success; | |
} | |
class DeployMessage { | |
/** | |
* @var boolean | |
*/ | |
public $changed; | |
/** | |
* @var int | |
*/ | |
public $columnNumber; | |
/** | |
* @var boolean | |
*/ | |
public $created; | |
/** | |
* @var boolean | |
*/ | |
public $deleted; | |
/** | |
* @var string | |
*/ | |
public $fileName; | |
/** | |
* @var string | |
*/ | |
public $fullName; | |
/** | |
* @var string | |
*/ | |
public $id; | |
/** | |
* @var int | |
*/ | |
public $lineNumber; | |
/** | |
* @var string | |
*/ | |
public $problem; | |
/** | |
* @var string | |
* NOTE: problemType should follow the following restrictions | |
* You can have one of the following value | |
* Warning | |
* Error | |
*/ | |
public $problemType; | |
/** | |
* @var boolean | |
*/ | |
public $success; | |
} | |
class RetrieveResult { | |
/** | |
* @var array[0, unbounded] of (object)FileProperties | |
*/ | |
public $fileProperties; | |
/** | |
* @var string | |
*/ | |
public $id; | |
/** | |
* @var array[0, unbounded] of (object)RetrieveMessage | |
*/ | |
public $messages; | |
// You need to set only one from the following two vars | |
/** | |
* @var Plain Binary | |
*/ | |
public $zipFile; | |
/** | |
* @var base64Binary | |
*/ | |
public $zipFile_encoded; | |
} | |
class FileProperties { | |
/** | |
* @var string | |
*/ | |
public $createdById; | |
/** | |
* @var string | |
*/ | |
public $createdByName; | |
/** | |
* @var dateTime | |
*/ | |
public $createdDate; | |
/** | |
* @var string | |
*/ | |
public $fileName; | |
/** | |
* @var string | |
*/ | |
public $fullName; | |
/** | |
* @var string | |
*/ | |
public $id; | |
/** | |
* @var string | |
*/ | |
public $lastModifiedById; | |
/** | |
* @var string | |
*/ | |
public $lastModifiedByName; | |
/** | |
* @var dateTime | |
*/ | |
public $lastModifiedDate; | |
/** | |
* @var string | |
* NOTE: manageableState should follow the following restrictions | |
* You can have one of the following value | |
* released | |
* deleted | |
* deprecated | |
* installed | |
* beta | |
* unmanaged | |
*/ | |
public $manageableState; | |
/** | |
* @var string | |
*/ | |
public $namespacePrefix; | |
/** | |
* @var string | |
*/ | |
public $type; | |
} | |
class RetrieveMessage { | |
/** | |
* @var string | |
*/ | |
public $fileName; | |
/** | |
* @var string | |
*/ | |
public $problem; | |
} | |
class RunTestsResult { | |
/** | |
* @var array[0, unbounded] of (object)CodeCoverageResult | |
*/ | |
public $codeCoverage; | |
/** | |
* @var array[0, unbounded] of (object)CodeCoverageWarning | |
*/ | |
public $codeCoverageWarnings; | |
/** | |
* @var array[0, unbounded] of (object)RunTestFailure | |
*/ | |
public $failures; | |
/** | |
* @var int | |
*/ | |
public $numFailures; | |
/** | |
* @var int | |
*/ | |
public $numTestsRun; | |
/** | |
* @var array[0, unbounded] of (object)RunTestSuccess | |
*/ | |
public $successes; | |
/** | |
* @var double | |
*/ | |
public $totalTime; | |
} | |
class CodeCoverageResult { | |
/** | |
* @var array[0, unbounded] of (object)CodeLocation | |
*/ | |
public $dmlInfo; | |
/** | |
* @var string | |
* NOTE: id should follow the following restrictions | |
* The value length should be | |
* 18 | |
* The pattern should be | |
* [a-zA-Z0-9]{18} | |
*/ | |
public $id; | |
/** | |
* @var array[0, unbounded] of (object)CodeLocation | |
*/ | |
public $locationsNotCovered; | |
/** | |
* @var array[0, unbounded] of (object)CodeLocation | |
*/ | |
public $methodInfo; | |
/** | |
* @var string | |
*/ | |
public $name; | |
/** | |
* @var string | |
*/ | |
public $namespace; | |
/** | |
* @var int | |
*/ | |
public $numLocations; | |
/** | |
* @var int | |
*/ | |
public $numLocationsNotCovered; | |
/** | |
* @var array[0, unbounded] of (object)CodeLocation | |
*/ | |
public $soqlInfo; | |
/** | |
* @var array[0, unbounded] of (object)CodeLocation | |
*/ | |
public $soslInfo; | |
/** | |
* @var string | |
*/ | |
public $type; | |
} | |
class CodeLocation { | |
/** | |
* @var int | |
*/ | |
public $column; | |
/** | |
* @var int | |
*/ | |
public $line; | |
/** | |
* @var int | |
*/ | |
public $numExecutions; | |
/** | |
* @var double | |
*/ | |
public $time; | |
} | |
class CodeCoverageWarning { | |
/** | |
* @var string | |
* NOTE: id should follow the following restrictions | |
* The value length should be | |
* 18 | |
* The pattern should be | |
* [a-zA-Z0-9]{18} | |
*/ | |
public $id; | |
/** | |
* @var string | |
*/ | |
public $message; | |
/** | |
* @var string | |
*/ | |
public $name; | |
/** | |
* @var string | |
*/ | |
public $namespace; | |
} | |
class RunTestFailure { | |
/** | |
* @var string | |
* NOTE: id should follow the following restrictions | |
* The value length should be | |
* 18 | |
* The pattern should be | |
* [a-zA-Z0-9]{18} | |
*/ | |
public $id; | |
/** | |
* @var string | |
*/ | |
public $message; | |
/** | |
* @var string | |
*/ | |
public $methodName; | |
/** | |
* @var string | |
*/ | |
public $name; | |
/** | |
* @var string | |
*/ | |
public $namespace; | |
/** | |
* @var string | |
*/ | |
public $packageName; | |
/** | |
* @var string | |
*/ | |
public $stackTrace; | |
/** | |
* @var double | |
*/ | |
public $time; | |
/** | |
* @var string | |
*/ | |
public $type; | |
} | |
class RunTestSuccess { | |
/** | |
* @var string | |
* NOTE: id should follow the following restrictions | |
* The value length should be | |
* 18 | |
* The pattern should be | |
* [a-zA-Z0-9]{18} | |
*/ | |
public $id; | |
/** | |
* @var string | |
*/ | |
public $methodName; | |
/** | |
* @var string | |
*/ | |
public $name; | |
/** | |
* @var string | |
*/ | |
public $namespace; | |
/** | |
* @var double | |
*/ | |
public $time; | |
} | |
class checkRetrieveStatus { | |
/** | |
* @var string | |
* NOTE: asyncProcessId should follow the following restrictions | |
* The value length should be | |
* 18 | |
* The pattern should be | |
* [a-zA-Z0-9]{18} | |
*/ | |
public $asyncProcessId; | |
} | |
class checkRetrieveStatusResponse { | |
/** | |
* @var (object)RetrieveResult | |
*/ | |
public $result; | |
} | |
class checkStatus { | |
/** | |
* @var array[0, unbounded] of string | |
* NOTE: asyncProcessId should follow the following restrictions | |
* The value length should be | |
* 18 | |
* The pattern should be | |
* [a-zA-Z0-9]{18} | |
*/ | |
public $asyncProcessId; | |
} | |
class checkStatusResponse { | |
/** | |
* @var array[0, unbounded] of (object)AsyncResult | |
*/ | |
public $result; | |
} | |
class AsyncResult { | |
/** | |
* @var boolean | |
*/ | |
public $checkOnly; | |
/** | |
* @var boolean | |
*/ | |
public $done; | |
/** | |
* @var string | |
* NOTE: id should follow the following restrictions | |
* The value length should be | |
* 18 | |
* The pattern should be | |
* [a-zA-Z0-9]{18} | |
*/ | |
public $id; | |
/** | |
* @var string | |
*/ | |
public $message; | |
/** | |
* @var int | |
*/ | |
public $numberComponentErrors; | |
/** | |
* @var int | |
*/ | |
public $numberComponentsDeployed; | |
/** | |
* @var int | |
*/ | |
public $numberComponentsTotal; | |
/** | |
* @var int | |
*/ | |
public $numberTestErrors; | |
/** | |
* @var int | |
*/ | |
public $numberTestsCompleted; | |
/** | |
* @var int | |
*/ | |
public $numberTestsTotal; | |
/** | |
* @var string | |
* NOTE: state should follow the following restrictions | |
* You can have one of the following value | |
* Queued | |
* InProgress | |
* Completed | |
* Error | |
*/ | |
public $state; | |
/** | |
* @var string | |
*/ | |
public $stateDetail; | |
/** | |
* @var dateTime | |
*/ | |
public $stateDetailLastModifiedDate; | |
/** | |
* @var string | |
* NOTE: statusCode should follow the following restrictions | |
* You can have one of the following value | |
* ALL_OR_NONE_OPERATION_ROLLED_BACK | |
* ALREADY_IN_PROCESS | |
* ASSIGNEE_TYPE_REQUIRED | |
* BAD_CUSTOM_ENTITY_PARENT_DOMAIN | |
* BCC_NOT_ALLOWED_IF_BCC_COMPLIANCE_ENABLED | |
* CANNOT_CASCADE_PRODUCT_ACTIVE | |
* CANNOT_CHANGE_FIELD_TYPE_OF_APEX_REFERENCED_FIELD | |
* CANNOT_CREATE_ANOTHER_MANAGED_PACKAGE | |
* CANNOT_DEACTIVATE_DIVISION | |
* CANNOT_DELETE_LAST_DATED_CONVERSION_RATE | |
* CANNOT_DELETE_MANAGED_OBJECT | |
* CANNOT_DISABLE_LAST_ADMIN | |
* CANNOT_ENABLE_IP_RESTRICT_REQUESTS | |
* CANNOT_INSERT_UPDATE_ACTIVATE_ENTITY | |
* CANNOT_MODIFY_MANAGED_OBJECT | |
* CANNOT_RENAME_APEX_REFERENCED_FIELD | |
* CANNOT_RENAME_APEX_REFERENCED_OBJECT | |
* CANNOT_REPARENT_RECORD | |
* CANNOT_UPDATE_CONVERTED_LEAD | |
* CANT_DISABLE_CORP_CURRENCY | |
* CANT_UNSET_CORP_CURRENCY | |
* CHILD_SHARE_FAILS_PARENT | |
* CIRCULAR_DEPENDENCY | |
* COMMUNITY_NOT_ACCESSIBLE | |
* CUSTOM_CLOB_FIELD_LIMIT_EXCEEDED | |
* CUSTOM_ENTITY_OR_FIELD_LIMIT | |
* CUSTOM_FIELD_INDEX_LIMIT_EXCEEDED | |
* CUSTOM_INDEX_EXISTS | |
* CUSTOM_LINK_LIMIT_EXCEEDED | |
* CUSTOM_TAB_LIMIT_EXCEEDED | |
* DELETE_FAILED | |
* DELETE_REQUIRED_ON_CASCADE | |
* DEPENDENCY_EXISTS | |
* DUPLICATE_CASE_SOLUTION | |
* DUPLICATE_COMM_NICKNAME | |
* DUPLICATE_CUSTOM_ENTITY_DEFINITION | |
* DUPLICATE_CUSTOM_TAB_MOTIF | |
* DUPLICATE_DEVELOPER_NAME | |
* DUPLICATE_EXTERNAL_ID | |
* DUPLICATE_MASTER_LABEL | |
* DUPLICATE_SENDER_DISPLAY_NAME | |
* DUPLICATE_USERNAME | |
* DUPLICATE_VALUE | |
* EMAIL_NOT_PROCESSED_DUE_TO_PRIOR_ERROR | |
* EMPTY_SCONTROL_FILE_NAME | |
* ENTITY_FAILED_IFLASTMODIFIED_ON_UPDATE | |
* ENTITY_IS_ARCHIVED | |
* ENTITY_IS_DELETED | |
* ENTITY_IS_LOCKED | |
* ERROR_IN_MAILER | |
* FAILED_ACTIVATION | |
* FIELD_CUSTOM_VALIDATION_EXCEPTION | |
* FIELD_FILTER_VALIDATION_EXCEPTION | |
* FIELD_INTEGRITY_EXCEPTION | |
* FILTERED_LOOKUP_LIMIT_EXCEEDED | |
* HTML_FILE_UPLOAD_NOT_ALLOWED | |
* IMAGE_TOO_LARGE | |
* INACTIVE_OWNER_OR_USER | |
* INSUFFICIENT_ACCESS_ON_CROSS_REFERENCE_ENTITY | |
* INSUFFICIENT_ACCESS_OR_READONLY | |
* INVALID_ACCESS_LEVEL | |
* INVALID_ARGUMENT_TYPE | |
* INVALID_ASSIGNEE_TYPE | |
* INVALID_ASSIGNMENT_RULE | |
* INVALID_BATCH_OPERATION | |
* INVALID_CONTENT_TYPE | |
* INVALID_CREDIT_CARD_INFO | |
* INVALID_CROSS_REFERENCE_KEY | |
* INVALID_CROSS_REFERENCE_TYPE_FOR_FIELD | |
* INVALID_CURRENCY_CONV_RATE | |
* INVALID_CURRENCY_CORP_RATE | |
* INVALID_CURRENCY_ISO | |
* INVALID_DATA_URI | |
* INVALID_EMAIL_ADDRESS | |
* INVALID_EMPTY_KEY_OWNER | |
* INVALID_FIELD | |
* INVALID_FIELD_FOR_INSERT_UPDATE | |
* INVALID_FIELD_WHEN_USING_TEMPLATE | |
* INVALID_FILTER_ACTION | |
* INVALID_GOOGLE_DOCS_URL | |
* INVALID_ID_FIELD | |
* INVALID_INET_ADDRESS | |
* INVALID_LINEITEM_CLONE_STATE | |
* INVALID_MASTER_OR_TRANSLATED_SOLUTION | |
* INVALID_MESSAGE_ID_REFERENCE | |
* INVALID_OPERATION | |
* INVALID_OPERATOR | |
* INVALID_OR_NULL_FOR_RESTRICTED_PICKLIST | |
* INVALID_PARTNER_NETWORK_STATUS | |
* INVALID_PERSON_ACCOUNT_OPERATION | |
* INVALID_READ_ONLY_USER_DML | |
* INVALID_SAVE_AS_ACTIVITY_FLAG | |
* INVALID_SESSION_ID | |
* INVALID_SETUP_OWNER | |
* INVALID_STATUS | |
* INVALID_TYPE | |
* INVALID_TYPE_FOR_OPERATION | |
* INVALID_TYPE_ON_FIELD_IN_RECORD | |
* IP_RANGE_LIMIT_EXCEEDED | |
* LICENSE_LIMIT_EXCEEDED | |
* LIGHT_PORTAL_USER_EXCEPTION | |
* LIMIT_EXCEEDED | |
* MALFORMED_ID | |
* MANAGER_NOT_DEFINED | |
* MASSMAIL_RETRY_LIMIT_EXCEEDED | |
* MASS_MAIL_LIMIT_EXCEEDED | |
* MAXIMUM_CCEMAILS_EXCEEDED | |
* MAXIMUM_DASHBOARD_COMPONENTS_EXCEEDED | |
* MAXIMUM_HIERARCHY_LEVELS_REACHED | |
* MAXIMUM_SIZE_OF_ATTACHMENT | |
* MAXIMUM_SIZE_OF_DOCUMENT | |
* MAX_ACTIONS_PER_RULE_EXCEEDED | |
* MAX_ACTIVE_RULES_EXCEEDED | |
* MAX_APPROVAL_STEPS_EXCEEDED | |
* MAX_FORMULAS_PER_RULE_EXCEEDED | |
* MAX_RULES_EXCEEDED | |
* MAX_RULE_ENTRIES_EXCEEDED | |
* MAX_TASK_DESCRIPTION_EXCEEEDED | |
* MAX_TM_RULES_EXCEEDED | |
* MAX_TM_RULE_ITEMS_EXCEEDED | |
* MERGE_FAILED | |
* MISSING_ARGUMENT | |
* MIXED_DML_OPERATION | |
* NONUNIQUE_SHIPPING_ADDRESS | |
* NO_APPLICABLE_PROCESS | |
* NO_ATTACHMENT_PERMISSION | |
* NO_INACTIVE_DIVISION_MEMBERS | |
* NO_MASS_MAIL_PERMISSION | |
* NUMBER_OUTSIDE_VALID_RANGE | |
* NUM_HISTORY_FIELDS_BY_SOBJECT_EXCEEDED | |
* OPTED_OUT_OF_MASS_MAIL | |
* OP_WITH_INVALID_USER_TYPE_EXCEPTION | |
* PACKAGE_LICENSE_REQUIRED | |
* PORTAL_USER_ALREADY_EXISTS_FOR_CONTACT | |
* PRIVATE_CONTACT_ON_ASSET | |
* RECORD_IN_USE_BY_WORKFLOW | |
* REQUEST_RUNNING_TOO_LONG | |
* REQUIRED_FEATURE_MISSING | |
* REQUIRED_FIELD_MISSING | |
* SELF_REFERENCE_FROM_TRIGGER | |
* SHARE_NEEDED_FOR_CHILD_OWNER | |
* SINGLE_EMAIL_LIMIT_EXCEEDED | |
* STANDARD_PRICE_NOT_DEFINED | |
* STORAGE_LIMIT_EXCEEDED | |
* STRING_TOO_LONG | |
* TABSET_LIMIT_EXCEEDED | |
* TEMPLATE_NOT_ACTIVE | |
* TERRITORY_REALIGN_IN_PROGRESS | |
* TEXT_DATA_OUTSIDE_SUPPORTED_CHARSET | |
* TOO_MANY_APEX_REQUESTS | |
* TOO_MANY_ENUM_VALUE | |
* TRANSFER_REQUIRES_READ | |
* UNABLE_TO_LOCK_ROW | |
* UNAVAILABLE_RECORDTYPE_EXCEPTION | |
* UNDELETE_FAILED | |
* UNKNOWN_EXCEPTION | |
* UNSPECIFIED_EMAIL_ADDRESS | |
* UNSUPPORTED_APEX_TRIGGER_OPERATON | |
* UNVERIFIED_SENDER_ADDRESS | |
* USER_OWNS_PORTAL_ACCOUNT_EXCEPTION | |
* USER_WITH_APEX_SHARES_EXCEPTION | |
* WEBLINK_SIZE_LIMIT_EXCEEDED | |
* WRONG_CONTROLLER_TYPE | |
*/ | |
public $statusCode; | |
} | |
class create { | |
/** | |
* @var array[0, unbounded] of (object)Metadata | |
* Or one of following derived class(es) | |
* CustomLabels | |
* CustomLabel | |
* CustomDataType | |
* CustomObject | |
* BusinessProcess | |
* PicklistValue | |
* CustomField | |
* ListView | |
* NamedFilter | |
* RecordType | |
* SharingReason | |
* ValidationRule | |
* WebLink | |
* ReportType | |
* Report | |
* Dashboard | |
* Layout | |
* CustomPageWebLink | |
* CustomTab | |
* CustomApplication | |
* Portal | |
* CustomSite | |
* Letterhead | |
* Workflow | |
* WorkflowRule | |
* HomePageComponent | |
* HomePageLayout | |
* CustomObjectTranslation | |
* Translations | |
* Profile | |
* DataCategoryGroup | |
* AnalyticSnapshot | |
* EntitlementTemplate | |
* RemoteSiteSetting | |
* Package | |
* Folder | |
* ReportFolder | |
* DashboardFolder | |
* DocumentFolder | |
* EmailFolder | |
* MetadataWithContent | |
* StaticResource | |
* Scontrol | |
* ApexComponent | |
* ApexPage | |
* Document | |
* EmailTemplate | |
* ApexClass | |
* ApexTrigger | |
* WorkflowAction | |
* WorkflowAlert | |
* WorkflowFieldUpdate | |
* WorkflowOutboundMessage | |
* WorkflowTask | |
*/ | |
public $metadata; | |
} | |
class Metadata { | |
/** | |
* @var string | |
*/ | |
public $fullName; | |
} | |
class CustomLabels extends Metadata { | |
/** | |
* @var array[0, unbounded] of (object)CustomLabel | |
*/ | |
public $labels; | |
} | |
class CustomLabel extends Metadata { | |
/** | |
* @var string | |
*/ | |
public $categories; | |
/** | |
* @var string | |
*/ | |
public $language; | |
/** | |
* @var boolean | |
*/ | |
public $protected; | |
/** | |
* @var string | |
*/ | |
public $shortDescription; | |
/** | |
* @var string | |
*/ | |
public $value; | |
} | |
class CustomDataType extends Metadata { | |
/** | |
* @var array[0, unbounded] of (object)CustomDataTypeComponent | |
*/ | |
public $customDataTypeComponents; | |
/** | |
* @var string | |
*/ | |
public $description; | |
/** | |
* @var string | |
*/ | |
public $displayFormula; | |
/** | |
* @var boolean | |
*/ | |
public $editComponentsOnSeparateLines; | |
/** | |
* @var string | |
*/ | |
public $label; | |
/** | |
* @var boolean | |
*/ | |
public $rightAligned; | |
/** | |
* @var boolean | |
*/ | |
public $supportComponentsInReports; | |
} | |
class CustomDataTypeComponent { | |
/** | |
* @var string | |
*/ | |
public $developerSuffix; | |
/** | |
* @var boolean | |
*/ | |
public $enforceFieldRequiredness; | |
/** | |
* @var string | |
*/ | |
public $label; | |
/** | |
* @var int | |
*/ | |
public $length; | |
/** | |
* @var int | |
*/ | |
public $precision; | |
/** | |
* @var int | |
*/ | |
public $scale; | |
/** | |
* @var string | |
* NOTE: sortOrder should follow the following restrictions | |
* You can have one of the following value | |
* Asc | |
* Desc | |
*/ | |
public $sortOrder; | |
/** | |
* @var int | |
*/ | |
public $sortPriority; | |
/** | |
* @var string | |
* NOTE: type should follow the following restrictions | |
* You can have one of the following value | |
* AutoNumber | |
* Lookup | |
* MasterDetail | |
* Checkbox | |
* Currency | |
* Date | |
* DateTime | |
* Number | |
* Percent | |
* Phone | |
* Picklist | |
* MultiselectPicklist | |
* Text | |
* TextArea | |
* LongTextArea | |
* Html | |
* Url | |
* EncryptedText | |
* Summary | |
* Hierarchy | |
* File | |
* CustomDataType | |
*/ | |
public $type; | |
} | |
class CustomObject extends Metadata { | |
/** | |
* @var array[0, unbounded] of (object)ActionOverride | |
*/ | |
public $actionOverrides; | |
/** | |
* @var (object)ArticleTypeChannelDisplay | |
*/ | |
public $articleTypeChannelDisplay; | |
/** | |
* @var array[0, unbounded] of (object)BusinessProcess | |
*/ | |
public $businessProcesses; | |
/** | |
* @var string | |
*/ | |
public $customHelp; | |
/** | |
* @var string | |
*/ | |
public $customHelpPage; | |
/** | |
* @var string | |
* NOTE: customSettingsType should follow the following restrictions | |
* You can have one of the following value | |
* List | |
* Hierarchy | |
*/ | |
public $customSettingsType; | |
/** | |
* @var string | |
* NOTE: customSettingsVisibility should follow the following restrictions | |
* You can have one of the following value | |
* Protected | |
* Public | |
*/ | |
public $customSettingsVisibility; | |
/** | |
* @var string | |
* NOTE: deploymentStatus should follow the following restrictions | |
* You can have one of the following value | |
* InDevelopment | |
* Deployed | |
*/ | |
public $deploymentStatus; | |
/** | |
* @var boolean | |
*/ | |
public $deprecated; | |
/** | |
* @var string | |
*/ | |
public $description; | |
/** | |
* @var boolean | |
*/ | |
public $enableActivities; | |
/** | |
* @var boolean | |
*/ | |
public $enableDivisions; | |
/** | |
* @var boolean | |
*/ | |
public $enableEnhancedLookup; | |
/** | |
* @var boolean | |
*/ | |
public $enableFeeds; | |
/** | |
* @var boolean | |
*/ | |
public $enableHistory; | |
/** | |
* @var boolean | |
*/ | |
public $enableReports; | |
/** | |
* @var array[0, unbounded] of (object)CustomField | |
*/ | |
public $fields; | |
/** | |
* @var string | |
* NOTE: gender should follow the following restrictions | |
* You can have one of the following value | |
* Neuter | |
* Masculine | |
* Feminine | |
*/ | |
public $gender; | |
/** | |
* @var boolean | |
*/ | |
public $household; | |
/** | |
* @var string | |
*/ | |
public $label; | |
/** | |
* @var array[0, unbounded] of (object)ListView | |
*/ | |
public $listViews; | |
/** | |
* @var (object)CustomField | |
*/ | |
public $nameField; | |
/** | |
* @var array[0, unbounded] of (object)NamedFilter | |
*/ | |
public $namedFilters; | |
/** | |
* @var string | |
*/ | |
public $pluralLabel; | |
/** | |
* @var boolean | |
*/ | |
public $recordTypeTrackFeedHistory; | |
/** | |
* @var boolean | |
*/ | |
public $recordTypeTrackHistory; | |
/** | |
* @var array[0, unbounded] of (object)RecordType | |
*/ | |
public $recordTypes; | |
/** | |
* @var (object)SearchLayouts | |
*/ | |
public $searchLayouts; | |
/** | |
* @var string | |
* NOTE: sharingModel should follow the following restrictions | |
* You can have one of the following value | |
* Private | |
* Read | |
* ReadWrite | |
* ReadWriteTransfer | |
* FullAccess | |
* ControlledByParent | |
*/ | |
public $sharingModel; | |
/** | |
* @var array[0, unbounded] of (object)SharingReason | |
*/ | |
public $sharingReasons; | |
/** | |
* @var array[0, unbounded] of (object)SharingRecalculation | |
*/ | |
public $sharingRecalculations; | |
/** | |
* @var string | |
* NOTE: startsWith should follow the following restrictions | |
* You can have one of the following value | |
* Consonant | |
* Vowel | |
* Special | |
*/ | |
public $startsWith; | |
/** | |
* @var array[0, unbounded] of (object)ValidationRule | |
*/ | |
public $validationRules; | |
/** | |
* @var array[0, unbounded] of (object)WebLink | |
*/ | |
public $webLinks; | |
} | |
class ActionOverride { | |
/** | |
* @var string | |
*/ | |
public $actionName; | |
/** | |
* @var string | |
*/ | |
public $comment; | |
/** | |
* @var string | |
*/ | |
public $content; | |
/** | |
* @var string | |
* NOTE: type should follow the following restrictions | |
* You can have one of the following value | |
* Default | |
* Standard | |
* Scontrol | |
* Visualforce | |
*/ | |
public $type; | |
} | |
class ArticleTypeChannelDisplay { | |
/** | |
* @var array[0, unbounded] of (object)ArticleTypeTemplate | |
*/ | |
public $articleTypeTemplates; | |
} | |
class ArticleTypeTemplate { | |
/** | |
* @var string | |
* NOTE: channel should follow the following restrictions | |
* You can have one of the following value | |
* AllChannels | |
* App | |
* Pkb | |
* Csp | |
* Prm | |
*/ | |
public $channel; | |
/** | |
* @var string | |
*/ | |
public $page; | |
/** | |
* @var string | |
* NOTE: template should follow the following restrictions | |
* You can have one of the following value | |
* Page | |
* Tab | |
* Toc | |
*/ | |
public $template; | |
} | |
class BusinessProcess extends Metadata { | |
/** | |
* @var string | |
*/ | |
public $description; | |
/** | |
* @var boolean | |
*/ | |
public $isActive; | |
/** | |
* @var array[0, unbounded] of (object)PicklistValue | |
*/ | |
public $values; | |
} | |
class PicklistValue extends Metadata { | |
/** | |
* @var boolean | |
*/ | |
public $allowEmail; | |
/** | |
* @var boolean | |
*/ | |
public $closed; | |
/** | |
* @var string | |
*/ | |
public $color; | |
/** | |
* @var array[0, unbounded] of string | |
*/ | |
public $controllingFieldValues; | |
/** | |
* @var boolean | |
*/ | |
public $converted; | |
/** | |
* @var boolean | |
*/ | |
public $cssExposed; | |
/** | |
* @var boolean | |
*/ | |
public $default; | |
/** | |
* @var string | |
*/ | |
public $description; | |
/** | |
* @var string | |
* NOTE: forecastCategory should follow the following restrictions | |
* You can have one of the following value | |
* Omitted | |
* Pipeline | |
* BestCase | |
* Forecast | |
* Closed | |
*/ | |
public $forecastCategory; | |
/** | |
* @var boolean | |
*/ | |
public $highPriority; | |
/** | |
* @var int | |
*/ | |
public $probability; | |
/** | |
* @var string | |
*/ | |
public $reverseRole; | |
/** | |
* @var boolean | |
*/ | |
public $reviewed; | |
/** | |
* @var boolean | |
*/ | |
public $won; | |
} | |
class CustomField extends Metadata { | |
/** | |
* @var boolean | |
*/ | |
public $caseSensitive; | |
/** | |
* @var string | |
*/ | |
public $customDataType; | |
/** | |
* @var string | |
*/ | |
public $defaultValue; | |
/** | |
* @var boolean | |
*/ | |
public $deprecated; | |
/** | |
* @var string | |
*/ | |
public $description; | |
/** | |
* @var string | |
*/ | |
public $displayFormat; | |
/** | |
* @var boolean | |
*/ | |
public $escapeMarkup; | |
/** | |
* @var boolean | |
*/ | |
public $externalId; | |
/** | |
* @var string | |
*/ | |
public $formula; | |
/** | |
* @var string | |
* NOTE: formulaTreatBlanksAs should follow the following restrictions | |
* You can have one of the following value | |
* BlankAsBlank | |
* BlankAsZero | |
*/ | |
public $formulaTreatBlanksAs; | |
/** | |
* @var string | |
*/ | |
public $inlineHelpText; | |
/** | |
* @var string | |
*/ | |
public $label; | |
/** | |
* @var int | |
*/ | |
public $length; | |
/** | |
* @var string | |
* NOTE: maskChar should follow the following restrictions | |
* You can have one of the following value | |
* asterisk | |
* X | |
*/ | |
public $maskChar; | |
/** | |
* @var string | |
* NOTE: maskType should follow the following restrictions | |
* You can have one of the following value | |
* all | |
* creditCard | |
* ssn | |
* lastFour | |
* sin | |
* nino | |
*/ | |
public $maskType; | |
/** | |
* @var (object)Picklist | |
*/ | |
public $picklist; | |
/** | |
* @var boolean | |
*/ | |
public $populateExistingRows; | |
/** | |
* @var int | |
*/ | |
public $precision; | |
/** | |
* @var string | |
*/ | |
public $referenceTo; | |
/** | |
* @var string | |
*/ | |
public $relationshipLabel; | |
/** | |
* @var string | |
*/ | |
public $relationshipName; | |
/** | |
* @var int | |
*/ | |
public $relationshipOrder; | |
/** | |
* @var boolean | |
*/ | |
public $required; | |
/** | |
* @var boolean | |
*/ | |
public $restrictedAdminField; | |
/** | |
* @var int | |
*/ | |
public $scale; | |
/** | |
* @var int | |
*/ | |
public $startingNumber; | |
/** | |
* @var boolean | |
*/ | |
public $stripMarkup; | |
/** | |
* @var string | |
*/ | |
public $summarizedField; | |
/** | |
* @var array[0, unbounded] of (object)FilterItem | |
*/ | |
public $summaryFilterItems; | |
/** | |
* @var string | |
*/ | |
public $summaryForeignKey; | |
/** | |
* @var string | |
* NOTE: summaryOperation should follow the following restrictions | |
* You can have one of the following value | |
* count | |
* sum | |
* min | |
* max | |
*/ | |
public $summaryOperation; | |
/** | |
* @var boolean | |
*/ | |
public $trackFeedHistory; | |
/** | |
* @var boolean | |
*/ | |
public $trackHistory; | |
/** | |
* @var string | |
* NOTE: type should follow the following restrictions | |
* You can have one of the following value | |
* AutoNumber | |
* Lookup | |
* MasterDetail | |
* Checkbox | |
* Currency | |
* Date | |
* DateTime | |
* Number | |
* Percent | |
* Phone | |
* Picklist | |
* MultiselectPicklist | |
* Text | |
* TextArea | |
* LongTextArea | |
* Html | |
* Url | |
* EncryptedText | |
* Summary | |
* Hierarchy | |
* File | |
* CustomDataType | |
*/ | |
public $type; | |
/** | |
* @var boolean | |
*/ | |
public $unique; | |
/** | |
* @var int | |
*/ | |
public $visibleLines; | |
/** | |
* @var boolean | |
*/ | |
public $writeRequiresMasterRead; | |
} | |
class Picklist { | |
/** | |
* @var string | |
*/ | |
public $controllingField; | |
/** | |
* @var array[0, unbounded] of (object)PicklistValue | |
*/ | |
public $picklistValues; | |
/** | |
* @var boolean | |
*/ | |
public $sorted; | |
} | |
class FilterItem { | |
/** | |
* @var string | |
*/ | |
public $field; | |
/** | |
* @var string | |
* NOTE: operation should follow the following restrictions | |
* You can have one of the following value | |
* equals | |
* notEqual | |
* lessThan | |
* greaterThan | |
* lessOrEqual | |
* greaterOrEqual | |
* contains | |
* notContain | |
* startsWith | |
* includes | |
* excludes | |
*/ | |
public $operation; | |
/** | |
* @var string | |
*/ | |
public $value; | |
/** | |
* @var string | |
*/ | |
public $valueField; | |
} | |
class ListView extends Metadata { | |
/** | |
* @var string | |
*/ | |
public $booleanFilter; | |
/** | |
* @var array[0, unbounded] of string | |
*/ | |
public $columns; | |
/** | |
* @var string | |
*/ | |
public $division; | |
/** | |
* @var string | |
* NOTE: filterScope should follow the following restrictions | |
* You can have one of the following value | |
* Everything | |
* Mine | |
* Queue | |
* Delegated | |
* MyTerritory | |
* MyTeamTerritory | |
* Team | |
*/ | |
public $filterScope; | |
/** | |
* @var array[0, unbounded] of (object)ListViewFilter | |
*/ | |
public $filters; | |
/** | |
* @var string | |
*/ | |
public $label; | |
/** | |
* @var string | |
* NOTE: language should follow the following restrictions | |
* You can have one of the following value | |
* en_US | |
* de | |
* es | |
* es_MX | |
* fr | |
* it | |
* ja | |
* sv | |
* ko | |
* zh_TW | |
* zh_CN | |
* pt_BR | |
* nl_NL | |
* da | |
* hu | |
* th | |
* fi | |
* pl | |
* ru | |
* cs | |
* tr | |
* in | |
* ro | |
* vi | |
* uk | |
* iw | |
* el | |
* bg | |
* en_GB | |
* ar | |
* fr_CA | |
* no | |
* ka | |
* sr | |
* sh | |
* sk | |
* en_AU | |
* en_MY | |
* en_IN | |
* en_PH | |
* en_CA | |
*/ | |
public $language; | |
/** | |
* @var string | |
*/ | |
public $queue; | |
/** | |
* @var (object)SharedTo | |
*/ | |
public $sharedTo; | |
} | |
class ListViewFilter { | |
/** | |
* @var string | |
*/ | |
public $field; | |
/** | |
* @var string | |
* NOTE: operation should follow the following restrictions | |
* You can have one of the following value | |
* equals | |
* notEqual | |
* lessThan | |
* greaterThan | |
* lessOrEqual | |
* greaterOrEqual | |
* contains | |
* notContain | |
* startsWith | |
* includes | |
* excludes | |
*/ | |
public $operation; | |
/** | |
* @var string | |
*/ | |
public $value; | |
} | |
class SharedTo { | |
/** | |
* @var array[0, unbounded] of string | |
*/ | |
public $groups; | |
/** | |
* @var array[0, unbounded] of string | |
*/ | |
public $roles; | |
/** | |
* @var array[0, unbounded] of string | |
*/ | |
public $rolesAndSubordinates; | |
/** | |
* @var array[0, unbounded] of string | |
*/ | |
public $territories; | |
/** | |
* @var array[0, unbounded] of string | |
*/ | |
public $territoriesAndSubordinates; | |
} | |
class NamedFilter extends Metadata { | |
/** | |
* @var boolean | |
*/ | |
public $active; | |
/** | |
* @var string | |
*/ | |
public $booleanFilter; | |
/** | |
* @var string | |
*/ | |
public $description; | |
/** | |
* @var string | |
*/ | |
public $errorMessage; | |
/** | |
* @var string | |
*/ | |
public $field; | |
/** | |
* @var array[0, unbounded] of (object)FilterItem | |
*/ | |
public $filterItems; | |
/** | |
* @var string | |
*/ | |
public $infoMessage; | |
/** | |
* @var boolean | |
*/ | |
public $isOptional; | |
/** | |
* @var string | |
*/ | |
public $name; | |
/** | |
* @var string | |
*/ | |
public $sourceObject; | |
} | |
class RecordType extends Metadata { | |
/** | |
* @var boolean | |
*/ | |
public $active; | |
/** | |
* @var string | |
*/ | |
public $businessProcess; | |
/** | |
* @var string | |
*/ | |
public $description; | |
/** | |
* @var string | |
*/ | |
public $label; | |
/** | |
* @var array[0, unbounded] of (object)RecordTypePicklistValue | |
*/ | |
public $picklistValues; | |
} | |
class RecordTypePicklistValue { | |
/** | |
* @var string | |
*/ | |
public $picklist; | |
/** | |
* @var array[0, unbounded] of (object)PicklistValue | |
*/ | |
public $values; | |
} | |
class SearchLayouts { | |
/** | |
* @var array[0, unbounded] of string | |
*/ | |
public $customTabListAdditionalFields; | |
/** | |
* @var array[0, unbounded] of string | |
*/ | |
public $excludedStandardButtons; | |
/** | |
* @var array[0, unbounded] of string | |
*/ | |
public $listViewButtons; | |
/** | |
* @var array[0, unbounded] of string | |
*/ | |
public $lookupDialogsAdditionalFields; | |
/** | |
* @var array[0, unbounded] of string | |
*/ | |
public $lookupFilterFields; | |
/** | |
* @var array[0, unbounded] of string | |
*/ | |
public $lookupPhoneDialogsAdditionalFields; | |
/** | |
* @var array[0, unbounded] of string | |
*/ | |
public $searchFilterFields; | |
/** | |
* @var array[0, unbounded] of string | |
*/ | |
public $searchResultsAdditionalFields; | |
/** | |
* @var array[0, unbounded] of string | |
*/ | |
public $searchResultsCustomButtons; | |
} | |
class SharingReason extends Metadata { | |
/** | |
* @var string | |
*/ | |
public $label; | |
} | |
class SharingRecalculation { | |
/** | |
* @var string | |
*/ | |
public $className; | |
} | |
class ValidationRule extends Metadata { | |
/** | |
* @var boolean | |
*/ | |
public $active; | |
/** | |
* @var string | |
*/ | |
public $description; | |
/** | |
* @var string | |
*/ | |
public $errorConditionFormula; | |
/** | |
* @var string | |
*/ | |
public $errorDisplayField; | |
/** | |
* @var string | |
*/ | |
public $errorMessage; | |
} | |
class WebLink extends Metadata { | |
/** | |
* @var string | |
* NOTE: availability should follow the following restrictions | |
* You can have one of the following value | |
* online | |
* offline | |
*/ | |
public $availability; | |
/** | |
* @var string | |
*/ | |
public $description; | |
/** | |
* @var string | |
* NOTE: displayType should follow the following restrictions | |
* You can have one of the following value | |
* link | |
* button | |
* massActionButton | |
*/ | |
public $displayType; | |
/** | |
* @var boolean | |
*/ | |
public $hasMenubar; | |
/** | |
* @var boolean | |
*/ | |
public $hasScrollbars; | |
/** | |
* @var boolean | |
*/ | |
public $hasToolbar; | |
/** | |
* @var int | |
*/ | |
public $height; | |
/** | |
* @var boolean | |
*/ | |
public $isResizable; | |
/** | |
* @var string | |
* NOTE: linkType should follow the following restrictions | |
* You can have one of the following value | |
* url | |
* sControl | |
* javascript | |
* page | |
*/ | |
public $linkType; | |
/** | |
* @var string | |
*/ | |
public $masterLabel; | |
/** | |
* @var string | |
* NOTE: openType should follow the following restrictions | |
* You can have one of the following value | |
* newWindow | |
* sidebar | |
* noSidebar | |
* replace | |
* onClickJavaScript | |
*/ | |
public $openType; | |
/** | |
* @var string | |
*/ | |
public $page; | |
/** | |
* @var string | |
* NOTE: position should follow the following restrictions | |
* You can have one of the following value | |
* fullScreen | |
* none | |
* topLeft | |
*/ | |
public $position; | |
/** | |
* @var boolean | |
*/ | |
public $protected; | |
/** | |
* @var boolean | |
*/ | |
public $requireRowSelection; | |
/** | |
* @var string | |
*/ | |
public $scontrol; | |
/** | |
* @var boolean | |
*/ | |
public $showsLocation; | |
/** | |
* @var boolean | |
*/ | |
public $showsStatus; | |
/** | |
* @var string | |
*/ | |
public $url; | |
/** | |
* @var int | |
*/ | |
public $width; | |
} | |
class ReportType extends Metadata { | |
/** | |
* @var string | |
*/ | |
public $baseObject; | |
/** | |
* @var string | |
* NOTE: category should follow the following restrictions | |
* You can have one of the following value | |
* accounts | |
* opportunities | |
* forecasts | |
* cases | |
* leads | |
* campaigns | |
* activities | |
* busop | |
* products | |
* admin | |
* territory | |
* other | |
* content | |
*/ | |
public $category; | |
/** | |
* @var boolean | |
*/ | |
public $deployed; | |
/** | |
* @var string | |
*/ | |
public $description; | |
/** | |
* @var (object)ObjectRelationship | |
*/ | |
public $join; | |
/** | |
* @var string | |
*/ | |
public $label; | |
/** | |
* @var array[0, unbounded] of (object)ReportLayoutSection | |
*/ | |
public $sections; | |
} | |
class ObjectRelationship { | |
/** | |
* @var (object)ObjectRelationship | |
*/ | |
public $join; | |
/** | |
* @var boolean | |
*/ | |
public $outerJoin; | |
/** | |
* @var string | |
*/ | |
public $relationship; | |
} | |
class ReportLayoutSection { | |
/** | |
* @var array[0, unbounded] of (object)ReportTypeColumn | |
*/ | |
public $columns; | |
/** | |
* @var string | |
*/ | |
public $masterLabel; | |
} | |
class ReportTypeColumn { | |
/** | |
* @var boolean | |
*/ | |
public $checkedByDefault; | |
/** | |
* @var string | |
*/ | |
public $displayNameOverride; | |
/** | |
* @var string | |
*/ | |
public $field; | |
/** | |
* @var string | |
*/ | |
public $table; | |
} | |
class Report extends Metadata { | |
/** | |
* @var array[0, unbounded] of (object)ReportAggregate | |
*/ | |
public $aggregates; | |
/** | |
* @var (object)ReportChart | |
*/ | |
public $chart; | |
/** | |
* @var array[0, unbounded] of (object)ReportColorRange | |
*/ | |
public $colorRanges; | |
/** | |
* @var array[0, unbounded] of (object)ReportColumn | |
*/ | |
public $columns; | |
/** | |
* @var string | |
* NOTE: currency should follow the following restrictions | |
* You can have one of the following value | |
* ADP | |
* AED | |
* AFA | |
* AFN | |
* ALL | |
* AMD | |
* ANG | |
* AOA | |
* ARS | |
* ATS | |
* AUD | |
* AWG | |
* AZM | |
* AZN | |
* BAM | |
* BBD | |
* BDT | |
* BEF | |
* BGL | |
* BGN | |
* BHD | |
* BIF | |
* BMD | |
* BND | |
* BOB | |
* BOV | |
* BRL | |
* BSD | |
* BTN | |
* BWP | |
* BYB | |
* BYR | |
* BZD | |
* CAD | |
* CDF | |
* CHF | |
* CLF | |
* CLP | |
* CNY | |
* COP | |
* CRC | |
* CUP | |
* CVE | |
* CYP | |
* CZK | |
* DEM | |
* DJF | |
* DKK | |
* DOP | |
* DZD | |
* EEK | |
* EGP | |
* ERN | |
* ESP | |
* ETB | |
* EUR | |
* FIM | |
* FJD | |
* FKP | |
* FRF | |
* GBP | |
* GEL | |
* GHC | |
* GHS | |
* GIP | |
* GMD | |
* GNF | |
* GRD | |
* GTQ | |
* GWP | |
* GYD | |
* HKD | |
* HNL | |
* HRK | |
* HTG | |
* HUF | |
* IDR | |
* IEP | |
* ILS | |
* INR | |
* IQD | |
* IRR | |
* ISK | |
* ITL | |
* JMD | |
* JOD | |
* JPY | |
* KES | |
* KGS | |
* KHR | |
* KMF | |
* KPW | |
* KRW | |
* KWD | |
* KYD | |
* KZT | |
* LAK | |
* LBP | |
* LKR | |
* LRD | |
* LSL | |
* LTL | |
* LUF | |
* LVL | |
* LYD | |
* MAD | |
* MDL | |
* MGA | |
* MGF | |
* MKD | |
* MMK | |
* MNT | |
* MOP | |
* MRO | |
* MTL | |
* MUR | |
* MVR | |
* MWK | |
* MXN | |
* MXV | |
* MYR | |
* MZM | |
* MZN | |
* NAD | |
* NGN | |
* NIO | |
* NLG | |
* NOK | |
* NPR | |
* NZD | |
* OMR | |
* PAB | |
* PEN | |
* PGK | |
* PHP | |
* PKR | |
* PLN | |
* PTE | |
* PYG | |
* QAR | |
* RMB | |
* ROL | |
* RON | |
* RSD | |
* RUB | |
* RUR | |
* RWF | |
* SAR | |
* SBD | |
* SCR | |
* SDD | |
* SDG | |
* SEK | |
* SGD | |
* SHP | |
* SIT | |
* SKK | |
* SLL | |
* SOS | |
* SRD | |
* SRG | |
* STD | |
* SVC | |
* SYP | |
* SZL | |
* THB | |
* TJR | |
* TJS | |
* TMM | |
* TMT | |
* TND | |
* TOP | |
* TPE | |
* TRL | |
* TRY | |
* TTD | |
* TWD | |
* TZS | |
* UAH | |
* UGX | |
* USD | |
* UYU | |
* UZS | |
* VEB | |
* VEF | |
* VND | |
* VUV | |
* WST | |
* XAF | |
* XCD | |
* XOF | |
* XPF | |
* YER | |
* YUM | |
* ZAR | |
* ZMK | |
* ZWD | |
*/ | |
public $currency; | |
/** | |
* @var string | |
*/ | |
public $description; | |
/** | |
* @var string | |
*/ | |
public $division; | |
/** | |
* @var (object)ReportFilter | |
*/ | |
public $filter; | |
/** | |
* @var string | |
* NOTE: format should follow the following restrictions | |
* You can have one of the following value | |
* Matrix | |
* Summary | |
* Tabular | |
*/ | |
public $format; | |
/** | |
* @var array[0, unbounded] of (object)ReportGrouping | |
*/ | |
public $groupingsAcross; | |
/** | |
* @var array[0, unbounded] of (object)ReportGrouping | |
*/ | |
public $groupingsDown; | |
/** | |
* @var string | |
*/ | |
public $name; | |
/** | |
* @var array[0, unbounded] of (object)ReportParam | |
*/ | |
public $params; | |
/** | |
* @var string | |
*/ | |
public $reportType; | |
/** | |
* @var string | |
*/ | |
public $roleHierarchyFilter; | |
/** | |
* @var int | |
*/ | |
public $rowLimit; | |
/** | |
* @var string | |
*/ | |
public $scope; | |
/** | |
* @var boolean | |
*/ | |
public $showDetails; | |
/** | |
* @var string | |
*/ | |
public $sortColumn; | |
/** | |
* @var string | |
* NOTE: sortOrder should follow the following restrictions | |
* You can have one of the following value | |
* Asc | |
* Desc | |
*/ | |
public $sortOrder; | |
/** | |
* @var string | |
*/ | |
public $territoryHierarchyFilter; | |
/** | |
* @var (object)ReportTimeFrameFilter | |
*/ | |
public $timeFrameFilter; | |
/** | |
* @var string | |
*/ | |
public $userFilter; | |
} | |
class ReportAggregate { | |
/** | |
* @var string | |
*/ | |
public $acrossGroupingContext; | |
/** | |
* @var string | |
*/ | |
public $calculatedFormula; | |
/** | |
* @var string | |
* NOTE: datatype should follow the following restrictions | |
* You can have one of the following value | |
* currency | |
* percent | |
* number | |
*/ | |
public $datatype; | |
/** | |
* @var string | |
*/ | |
public $description; | |
/** | |
* @var string | |
*/ | |
public $developerName; | |
/** | |
* @var string | |
*/ | |
public $downGroupingContext; | |
/** | |
* @var boolean | |
*/ | |
public $isActive; | |
/** | |
* @var string | |
*/ | |
public $masterLabel; | |
/** | |
* @var int | |
*/ | |
public $scale; | |
} | |
class ReportChart { | |
/** | |
* @var string | |
*/ | |
public $backgroundColor1; | |
/** | |
* @var string | |
*/ | |
public $backgroundColor2; | |
/** | |
* @var string | |
* NOTE: backgroundFadeDir should follow the following restrictions | |
* You can have one of the following value | |
* TopToBottom | |
* LeftToRight | |
* Diagonal | |
*/ | |
public $backgroundFadeDir; | |
/** | |
* @var array[0, unbounded] of (object)ChartSummary | |
*/ | |
public $chartSummaries; | |
/** | |
* @var string | |
* NOTE: chartType should follow the following restrictions | |
* You can have one of the following value | |
* None | |
* HorizontalBar | |
* HorizontalBarGrouped | |
* HorizontalBarStacked | |
* HorizontalBarStackedTo100 | |
* VerticalColumn | |
* VerticalColumnGrouped | |
* VerticalColumnStacked | |
* VerticalColumnStackedTo100 | |
* Line | |
* LineGrouped | |
* LineCumulative | |
* LineCumulativeGrouped | |
* Pie | |
* Donut | |
* Funnel | |
* VerticalColumnLine | |
* VerticalColumnGroupedLine | |
* VerticalColumnStackedLine | |
*/ | |
public $chartType; | |
/** | |
* @var boolean | |
*/ | |
public $enableHoverLabels; | |
/** | |
* @var boolean | |
*/ | |
public $expandOthers; | |
/** | |
* @var string | |
*/ | |
public $groupingColumn; | |
/** | |
* @var string | |
* NOTE: legendPosition should follow the following restrictions | |
* You can have one of the following value | |
* Right | |
* Bottom | |
* OnChart | |
*/ | |
public $legendPosition; | |
/** | |
* @var string | |
* NOTE: location should follow the following restrictions | |
* You can have one of the following value | |
* CHART_TOP | |
* CHART_BOTTOM | |
*/ | |
public $location; | |
/** | |
* @var string | |
*/ | |
public $secondaryGroupingColumn; | |
/** | |
* @var boolean | |
*/ | |
public $showAxisLabels; | |
/** | |
* @var boolean | |
*/ | |
public $showPercentage; | |
/** | |
* @var boolean | |
*/ | |
public $showTotal; | |
/** | |
* @var boolean | |
*/ | |
public $showValues; | |
/** | |
* @var string | |
* NOTE: size should follow the following restrictions | |
* You can have one of the following value | |
* Tiny | |
* Small | |
* Medium | |
* Large | |
* Huge | |
*/ | |
public $size; | |
/** | |
* @var double | |
*/ | |
public $summaryAxisManualRangeEnd; | |
/** | |
* @var double | |
*/ | |
public $summaryAxisManualRangeStart; | |
/** | |
* @var string | |
* NOTE: summaryAxisRange should follow the following restrictions | |
* You can have one of the following value | |
* Auto | |
* Manual | |
*/ | |
public $summaryAxisRange; | |
/** | |
* @var string | |
*/ | |
public $textColor; | |
/** | |
* @var int | |
*/ | |
public $textSize; | |
/** | |
* @var string | |
*/ | |
public $title; | |
/** | |
* @var string | |
*/ | |
public $titleColor; | |
/** | |
* @var int | |
*/ | |
public $titleSize; | |
} | |
class ChartSummary { | |
/** | |
* @var string | |
* NOTE: aggregate should follow the following restrictions | |
* You can have one of the following value | |
* Sum | |
* Average | |
* Maximum | |
* Minimum | |
* None | |
*/ | |
public $aggregate; | |
/** | |
* @var string | |
* NOTE: axisBinding should follow the following restrictions | |
* You can have one of the following value | |
* y | |
* y2 | |
*/ | |
public $axisBinding; | |
/** | |
* @var string | |
*/ | |
public $column; | |
} | |
class ReportColorRange { | |
/** | |
* @var string | |
* NOTE: aggregate should follow the following restrictions | |
* You can have one of the following value | |
* Sum | |
* Average | |
* Maximum | |
* Minimum | |
* None | |
*/ | |
public $aggregate; | |
/** | |
* @var string | |
*/ | |
public $columnName; | |
/** | |
* @var double | |
*/ | |
public $highBreakpoint; | |
/** | |
* @var string | |
*/ | |
public $highColor; | |
/** | |
* @var double | |
*/ | |
public $lowBreakpoint; | |
/** | |
* @var string | |
*/ | |
public $lowColor; | |
/** | |
* @var string | |
*/ | |
public $midColor; | |
} | |
class ReportColumn { | |
/** | |
* @var array[0, unbounded] of string | |
* NOTE: aggregateTypes should follow the following restrictions | |
* You can have one of the following value | |
* Sum | |
* Average | |
* Maximum | |
* Minimum | |
* None | |
*/ | |
public $aggregateTypes; | |
/** | |
* @var string | |
*/ | |
public $field; | |
} | |
class ReportFilter { | |
/** | |
* @var string | |
*/ | |
public $booleanFilter; | |
/** | |
* @var array[0, unbounded] of (object)ReportFilterItem | |
*/ | |
public $criteriaItems; | |
/** | |
* @var string | |
* NOTE: language should follow the following restrictions | |
* You can have one of the following value | |
* en_US | |
* de | |
* es | |
* es_MX | |
* fr | |
* it | |
* ja | |
* sv | |
* ko | |
* zh_TW | |
* zh_CN | |
* pt_BR | |
* nl_NL | |
* da | |
* hu | |
* th | |
* fi | |
* pl | |
* ru | |
* cs | |
* tr | |
* in | |
* ro | |
* vi | |
* uk | |
* iw | |
* el | |
* bg | |
* en_GB | |
* ar | |
* fr_CA | |
* no | |
* ka | |
* sr | |
* sh | |
* sk | |
* en_AU | |
* en_MY | |
* en_IN | |
* en_PH | |
* en_CA | |
*/ | |
public $language; | |
} | |
class ReportFilterItem { | |
/** | |
* @var string | |
*/ | |
public $column; | |
/** | |
* @var string | |
* NOTE: operator should follow the following restrictions | |
* You can have one of the following value | |
* equals | |
* notEqual | |
* lessThan | |
* greaterThan | |
* lessOrEqual | |
* greaterOrEqual | |
* contains | |
* notContain | |
* startsWith | |
* includes | |
* excludes | |
*/ | |
public $operator; | |
/** | |
* @var string | |
*/ | |
public $value; | |
} | |
class ReportGrouping { | |
/** | |
* @var string | |
* NOTE: dateGranularity should follow the following restrictions | |
* You can have one of the following value | |
* None | |
* Day | |
* Week | |
* Month | |
* Quarter | |
* Year | |
* FiscalQuarter | |
* FiscalYear | |
* MonthInYear | |
* DayInMonth | |
* FiscalPeriod | |
* FiscalWeek | |
*/ | |
public $dateGranularity; | |
/** | |
* @var string | |
*/ | |
public $field; | |
/** | |
* @var string | |
* NOTE: sortOrder should follow the following restrictions | |
* You can have one of the following value | |
* Asc | |
* Desc | |
*/ | |
public $sortOrder; | |
} | |
class ReportParam { | |
/** | |
* @var string | |
*/ | |
public $name; | |
/** | |
* @var string | |
*/ | |
public $value; | |
} | |
class ReportTimeFrameFilter { | |
/** | |
* @var string | |
*/ | |
public $dateColumn; | |
/** | |
* @var date | |
*/ | |
public $endDate; | |
/** | |
* @var string | |
* NOTE: interval should follow the following restrictions | |
* You can have one of the following value | |
* INTERVAL_CURRENT | |
* INTERVAL_CURNEXT1 | |
* INTERVAL_CURPREV1 | |
* INTERVAL_NEXT1 | |
* INTERVAL_PREV1 | |
* INTERVAL_CURNEXT3 | |
* INTERVAL_CURFY | |
* INTERVAL_PREVFY | |
* INTERVAL_PREV2FY | |
* INTERVAL_AGO2FY | |
* INTERVAL_NEXTFY | |
* INTERVAL_PREVCURFY | |
* INTERVAL_PREVCUR2FY | |
* INTERVAL_CURNEXTFY | |
* INTERVAL_CUSTOM | |
* INTERVAL_YESTERDAY | |
* INTERVAL_TODAY | |
* INTERVAL_TOMORROW | |
* INTERVAL_LASTWEEK | |
* INTERVAL_THISWEEK | |
* INTERVAL_NEXTWEEK | |
* INTERVAL_LASTMONTH | |
* INTERVAL_THISMONTH | |
* INTERVAL_NEXTMONTH | |
* INTERVAL_LASTTHISMONTH | |
* INTERVAL_THISNEXTMONTH | |
* INTERVAL_CURRENTQ | |
* INTERVAL_CURNEXTQ | |
* INTERVAL_CURPREVQ | |
* INTERVAL_NEXTQ | |
* INTERVAL_PREVQ | |
* INTERVAL_CURNEXT3Q | |
* INTERVAL_CURY | |
* INTERVAL_PREVY | |
* INTERVAL_PREV2Y | |
* INTERVAL_AGO2Y | |
* INTERVAL_NEXTY | |
* INTERVAL_PREVCURY | |
* INTERVAL_PREVCUR2Y | |
* INTERVAL_CURNEXTY | |
* INTERVAL_LAST7 | |
* INTERVAL_LAST30 | |
* INTERVAL_LAST60 | |
* INTERVAL_LAST90 | |
* INTERVAL_LAST120 | |
* INTERVAL_NEXT7 | |
* INTERVAL_NEXT30 | |
* INTERVAL_NEXT60 | |
* INTERVAL_NEXT90 | |
* INTERVAL_NEXT120 | |
* LAST_FISCALWEEK | |
* THIS_FISCALWEEK | |
* NEXT_FISCALWEEK | |
* LAST_FISCALPERIOD | |
* THIS_FISCALPERIOD | |
* NEXT_FISCALPERIOD | |
* LASTTHIS_FISCALPERIOD | |
* THISNEXT_FISCALPERIOD | |
* CURRENT_ENTITLEMENT_PERIOD | |
* PREVIOUS_ENTITLEMENT_PERIOD | |
* PREVIOUS_TWO_ENTITLEMENT_PERIODS | |
* TWO_ENTITLEMENT_PERIODS_AGO | |
* CURRENT_AND_PREVIOUS_ENTITLEMENT_PERIOD | |
* CURRENT_AND_PREVIOUS_TWO_ENTITLEMENT_PERIODS | |
*/ | |
public $interval; | |
/** | |
* @var date | |
*/ | |
public $startDate; | |
} | |
class Dashboard extends Metadata { | |
/** | |
* @var string | |
*/ | |
public $backgroundEndColor; | |
/** | |
* @var string | |
* NOTE: backgroundFadeDirection should follow the following restrictions | |
* You can have one of the following value | |
* TopToBottom | |
* LeftToRight | |
* Diagonal | |
*/ | |
public $backgroundFadeDirection; | |
/** | |
* @var string | |
*/ | |
public $backgroundStartColor; | |
/** | |
* @var string | |
* NOTE: dashboardType should follow the following restrictions | |
* You can have one of the following value | |
* SpecifiedUser | |
* LoggedInUser | |
* MyTeamUser | |
*/ | |
public $dashboardType; | |
/** | |
* @var string | |
*/ | |
public $description; | |
/** | |
* @var (object)DashboardComponentSection | |
*/ | |
public $leftSection; | |
/** | |
* @var (object)DashboardComponentSection | |
*/ | |
public $middleSection; | |
/** | |
* @var (object)DashboardComponentSection | |
*/ | |
public $rightSection; | |
/** | |
* @var string | |
*/ | |
public $runningUser; | |
/** | |
* @var string | |
*/ | |
public $textColor; | |
/** | |
* @var string | |
*/ | |
public $title; | |
/** | |
* @var string | |
*/ | |
public $titleColor; | |
/** | |
* @var int | |
*/ | |
public $titleSize; | |
} | |