@salesforce/afv-skills 1.22.0 → 1.24.0

package/skills/getting-metadata-api-context/data/metadata_api/RecordActionDeployment.json

@@ -1,184 +0,0 @@
-{
-  "sections": [
-    "title",
-    "description",
-    "file_information",
-    "directory_location",
-    "fields",
-    "sub_types",
-    "wsdl_segment",
-    "declarative_metadata_sample_definition"
-  ],
-  "title": "RecordActionDeployment - Metadata API",
-  "description": "Represents configuration settings for the Actions & Recommendations, Action Launcher, and Bulk Action Panel components. For example, you can have a deployment that specifies which types of actions to display, default actions for channels, and the actions that users can add at runtime. If the component shows Next Best Action recommendations, the deployment configures which strategies to use and how recommendations appear. This type extends the Metadata metadata type and inherits its fullName field.",
-  "file_information": ".deployment",
-  "directory_location": "recordActionDeployments",
-  "fields_columns": [
-    "type",
-    "description"
-  ],
-  "fields": {
-    "channelConfigurations": {
-      "type": "RecordActionDeploymentChannel",
-      "description": "Specifies configuration settings for different channels in an Actions & Recommendations deployment."
-    },
-    "componentName": {
-      "type": "ComponentName (enumeration of type string)",
-      "description": "Specifies the name of the component used in the deployment: ActionsAndRecommendations—0 ActionLauncher—1 BulkActionPanel—2. This value is available in API version 60.0 and later For example, a value of 1 indicates that 1 is stored in the database if Action Launcher is used to create a deployment. Available in API version 56.0 and later."
-    },
-    "deploymentContexts": {
-      "type": "RecordActionDeploymentContext",
-      "description": "Specifies the object context for quick actions and Next Best Action strategies. Available in API version 46.0 and later."
-    },
-    "hasComponents": {
-      "type": "boolean",
-      "description": "Indicates whether the record actions deployment includes components (true) or not (false). Available in API version 61.0 and later."
-    },
-    "hasGuidedActions": {
-      "type": "boolean",
-      "description": "Specifies that the component shows standard actions; for example, flows and quick actions. Available in API version 46.0 and later."
-    },
-    "hasOmniscripts": {
-      "type": "boolean",
-      "description": "Indicates whether the record actions deployment includes OmniScripts (true) or not (false). Available in API version 56.0 and later. The default value is false."
-    },
-    "hasRecommendations": {
-      "type": "boolean",
-      "description": "Specifies that the component shows recommendations from a Next Best Action strategy. Available in API version 46.0 and later."
-    },
-    "masterLabel": {
-      "type": "string",
-      "description": "Specifies the name of the deployment.",
-      "required": true
-    },
-    "recommendation": {
-      "type": "RecordActionRecommendation",
-      "description": "Specifies settings for how Next Best Action recommendations appear in the component. Available in API version 46.0 and later."
-    },
-    "selectableItems": {
-      "type": "RecordActionDeploymentSelectableItems",
-      "description": "Specifies the actions that users can add at runtime."
-    },
-    "shouldLaunchActionOnReject": {
-      "type": "boolean",
-      "description": "If true, launch the flow when the recommendation is rejected by the agent. Available in API version 48.0 and later.",
-      "required": true
-    }
-  },
-  "sub_types": {
-    "RecordActionDefaultItem": {
-      "action": {
-        "type": "string",
-        "description": "Specifies the API name of an action. For example, the API name of a flow, such as Verify_Information.",
-        "required": true
-      },
-      "isMandatory": {
-        "type": "boolean",
-        "description": "Specifies whether the action is marked as mandatory. The default value is false."
-      },
-      "isUiRemoveHidden": {
-        "type": "boolean",
-        "description": "Specifies whether the remove option is hidden in the UI. The default value is false. If true, the UI hides the ability to remove the action from the list."
-      },
-      "pinned": {
-        "type": "PinnedAction (enumeration of type string)",
-        "description": "Indicates whether the action is pinned to the Top or Bottom, or unpinned ( None ). The default value is None.",
-        "required": true
-      },
-      "position": {
-        "type": "int",
-        "description": "Indicates the order of the action among all actions associated with this record.",
-        "required": true
-      },
-      "type": {
-        "type": "RecordActionType (enumeration of type string)",
-        "description": "The type of action that’s associated with the record. Valid values are: Flow QuickAction (Available in API version 46.0 and later.) OmniScript (Available in API version 56.0 and later.) LWC (Available in API version 62.0 and later.) SvcCatalogItemDef (Available in API version 62.0 and later.) WebLink (Available in API version 62.0 and later.)",
-        "required": true
-      }
-    },
-    "RecordActionDeploymentChannel": {
-      "channel": {
-        "type": "ChannelSource (enumeration of type string)",
-        "description": "Specifies the channel. Valid values are Phone, Chat, or Default.",
-        "required": true
-      },
-      "channelItems": {
-        "type": "RecordActionDefaultItem",
-        "description": "Specifies default actions for a channel and attributes for each action, such as whether the action is pinned to the list top or bottom or whether an action is considered mandatory."
-      },
-      "isAutopopEnabled": {
-        "type": "boolean",
-        "description": "Specifies whether the first action in the list is launched when the record page opens. If true, the first action is launched. The default value is false."
-      }
-    },
-    "RecordActionDeploymentContext": {
-      "entityName": {
-        "type": "string",
-        "description": "Specifies the API name of an object to use as context.",
-        "required": true
-      },
-      "recommendationStrategy": {
-        "type": "string",
-        "description": "Specifies the API name of a Next Best Action strategy that overrides the default strategy on this page. A strategy is a metadata type RecommendationStrategy."
-      }
-    },
-    "RecordActionRecommendation": {
-      "defaultStrategy": {
-        "type": "string",
-        "description": "Specifies the API name of the default Next Best Action strategy, which is a metadata type, RecommendationStrategy."
-      },
-      "hasDescription": {
-        "type": "boolean",
-        "description": "If true, display the description for the recommendation.",
-        "required": true
-      },
-      "hasImage": {
-        "type": "boolean",
-        "description": "If true, display the image for the recommendation.",
-        "required": true
-      },
-      "hasRejectAction": {
-        "type": "boolean",
-        "description": "If true, display the label that the user clicks to reject the recommendation.",
-        "required": true
-      },
-      "hasTitle": {
-        "type": "boolean",
-        "description": "If true, display the title for the recommendation.",
-        "required": true
-      },
-      "maxDisplayRecommendations": {
-        "type": "int",
-        "description": "Specifies the maximum number of recommendations to display. Valid values are 1–4.",
-        "required": true
-      }
-    },
-    "RecordActionSelectableItem": {
-      "action": {
-        "type": "string",
-        "description": "Specifies the API name of an action. For example, the API name of a flow, such as Verify_Information.",
-        "required": true
-      },
-      "type": {
-        "type": "RecordActionType (enumeration of type string)",
-        "description": "The type of action that’s associated with the record. Valid values are: Flow QuickAction (Available in API version 46.0 and later.) OmniScript (Available in API version 56.0 and later.) LWC (Available in API version 62.0 and later.) SvcCatalogItemDef (Available in API version 62.0 and later.) WebLink (Available in API version 62.0 and later.)",
-        "required": true
-      },
-      "isFrequentAction": {
-        "type": "boolean",
-        "description": "Indicates whether an action is frequently accessed by users (true) or not (false). Available in version 57.0 and later. This field applies only to Action Launcher."
-      },
-      "frequentActionSequenceNbr": {
-        "type": "integer",
-        "description": "The sequence number that's assigned to a frequently used action that's shown on Action Launcher. Available in version 57.0 and later. This field applies only to Action Launcher."
-      }
-    }
-  },
-  "wsdl_segment": "```xml\n<xsd:simpleType name=\"ChannelSource\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"Other\"/>\n    <xsd:enumeration value=\"Phone\"/>\n    <xsd:enumeration value=\"Chat\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:simpleType name=\"ComponentName\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"ActionsAndRecommendations\"/>\n    <xsd:enumeration value=\"ActionLauncher\"/>\n    <xsd:enumeration value=\"BulkActionPanel\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"Metadata\">\n  <xsd:sequence>\n    <xsd:element name=\"fullName\" minOccurs=\"0\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:simpleType name=\"PinnedAction\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"None\"/>\n    <xsd:enumeration value=\"Top\"/>\n    <xsd:enumeration value=\"Bottom\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"RecordActionDefaultItem\">\n  <xsd:sequence>\n    <xsd:element name=\"action\" type=\"xsd:string\"/>\n    <xsd:element name=\"isMandatory\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n    <xsd:element name=\"isUiRemoveHidden\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n    <xsd:element name=\"pinned\" type=\"tns:PinnedAction\"/>\n    <xsd:element name=\"position\" type=\"xsd:int\"/>\n    <xsd:element name=\"type\" type=\"tns:RecordActionType\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"RecordActionDeployment\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"channelConfigurations\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:RecordActionDeploymentChannel\"/>\n        <xsd:element name=\"componentName\" minOccurs=\"0\" type=\"tns:ComponentName\"/>\n        <xsd:element name=\"deploymentContexts\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:RecordActionDeploymentContext\"/>\n        <xsd:element name=\"hasComponents\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"hasGuidedActions\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"hasOmniscripts\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"hasRecommendations\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"masterLabel\" type=\"xsd:string\"/>\n        <xsd:element name=\"recommendation\" minOccurs=\"0\" type=\"tns:RecordActionRecommendation\"/>\n        <xsd:element name=\"selectableItems\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:RecordActionSelectableItem\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"RecordActionDeploymentChannel\">\n  <xsd:sequence>\n    <xsd:element name=\"channel\" type=\"tns:ChannelSource\"/>\n    <xsd:element name=\"channelItems\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:RecordActionDefaultItem\"/>\n    <xsd:element name=\"isAutopopEnabled\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"RecordActionDeploymentContext\">\n  <xsd:sequence>\n    <xsd:element name=\"entityName\" type=\"xsd:string\"/>\n    <xsd:element name=\"recommendationStrategy\" minOccurs=\"0\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"RecordActionRecommendation\">\n  <xsd:sequence>\n    <xsd:element name=\"defaultStrategy\" minOccurs=\"0\" type=\"xsd:string\"/>\n    <xsd:element name=\"hasDescription\" type=\"xsd:boolean\"/>\n    <xsd:element name=\"hasImage\" type=\"xsd:boolean\"/>\n    <xsd:element name=\"hasRejectAction\" type=\"xsd:boolean\"/>\n    <xsd:element name=\"hasTitle\" type=\"xsd:boolean\"/>\n    <xsd:element name=\"maxDisplayRecommendations\" type=\"xsd:int\"/>\n    <xsd:element name=\"shouldLaunchActionOnReject\" type=\"xsd:boolean\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"RecordActionSelectableItem\">\n  <xsd:sequence>\n    <xsd:element name=\"action\" type=\"xsd:string\"/>\n    <xsd:element name=\"frequentActionSequenceNbr\" minOccurs=\"0\" type=\"xsd:int\"/>\n    <xsd:element name=\"isFrequentAction\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n    <xsd:element name=\"type\" type=\"tns:RecordActionType\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:simpleType name=\"RecordActionType\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"Flow\"/>\n    <xsd:enumeration value=\"QuickAction\"/>\n    <xsd:enumeration value=\"Omniscript\"/>\n    <xsd:enumeration value=\"LWC\"/>\n    <xsd:enumeration value=\"WebLink\"/>\n    <xsd:enumeration value=\"SvcCatalogItemDef\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n```",
-  "declarative_metadata_sample_definition": [
-    {
-      "description": "The following is a sample of a recordActionDeployment file.",
-      "code": "<RecordActionDeployment xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n    <channelConfigurations>\n        <channel>Phone</channel>\n        <channelItems>\n            <action>Sample_Flow</action>\n            <isMandatory>false</isMandatory>\n            <isUiRemoveHidden>false</isUiRemoveHidden>\n            <position>1</position>\n            <pinned>Top</pinned>\n            <type>Flow</type>\n        </channelItems>\n        <channelItems>\n            <action>Another_Sample_Flow</action>\n            <isMandatory>false</isMandatory>\n            <isUiRemoveHidden>true</isUiRemoveHidden>\n            <position>2</position>\n            <pinned>Top</pinned>\n            <type>Flow</type>\n        </channelItems>\n        <isAutopopEnabled>true</isAutopopEnabled>\n    </channelConfigurations>\n    <masterLabel>Sample Deployment</masterLabel>\n    <selectableItems>\n        <action>Sample_Flow</action>\n        <type>Flow</type>\n        <isFrequentAction>true</isFrequentAction>\n        <frequentActionSequenceNbr>1</frequentActionSequenceNbr>\n    </selectableItems>\n    <selectableItems>\n        <action>Sample_Flow_2</action>\n        <type>Flow</type>\n        <isFrequentAction>false</isFrequentAction>\n    </selectableItems>\n    <hasGuidedActions>true</hasGuidedActions>\n    <hasRecommendations>true</hasRecommendations>\n    <recommendation>\n        <defaultStrategy>Sample_Global_Strategy</defaultStrategy>\n        <maxDisplayRecommendations>4</maxDisplayRecommendations>\n        <hasImage>true</hasImage>\n        <hasDescription>true</hasDescription>\n        <hasRejectAction>true</hasRejectAction>\n        <hasTitle>true</hasTitle>\n    </recommendation>\n    <deploymentContexts>\n        <entityName>Case</entityName>\n        <recommendationStrategy>Sample_Case_Strategy</recommendationStrategy>\n    </deploymentContexts>\n    <deploymentContexts>\n        <entityName>Account</entityName>\n        <recommendationStrategy>Sample_Acc_Strategy</recommendationStrategy>\n    </deploymentContexts>\n</RecordActionDeployment>"
-    }
-  ]
-}

package/skills/getting-metadata-api-context/data/metadata_api/RecordAggregationDefinition.json

@@ -1,148 +0,0 @@
-{
-  "sections": [
-    "title",
-    "description",
-    "file_information",
-    "directory_location",
-    "fields",
-    "sub_types",
-    "declarative_metadata_sample_definition"
-  ],
-  "title": "RecordAggregationDefinition - Metadata API",
-  "description": "Represents a data aggregation from one object to another object to which it is connected by other objects in the data model.",
-  "file_information": ".RecordAggregationDefinition",
-  "directory_location": "RecordAggregationDefinitions",
-  "fields_columns": [
-    "type",
-    "required",
-    "description"
-  ],
-  "fields": {
-    "aggregateFromObject": {
-      "type": "string",
-      "required": true,
-      "description": "API name of the object from which data is aggregated."
-    },
-    "aggregateToObject": {
-      "type": "string",
-      "required": true,
-      "description": "API name of the object to which data is aggregated."
-    },
-    "aggregationType": {
-      "type": "RecordAggregationDefinitionAggregationType (enumeration of type string)",
-      "required": true,
-      "description": "Type of the data aggregation. Valid value is: Record"
-    },
-    "batchProcessingDefinition": {
-      "type": "string",
-      "description": "Data Processing Engine definition that aggregates data from one record to another."
-    },
-    "description": {
-      "type": "string",
-      "description": "Description for this record aggregation definition."
-    },
-    "displayName": {
-      "type": "string",
-      "required": true,
-      "description": "Name of the record aggregation definition that's displayed in the record page."
-    },
-    "onDemandProcDefinition": {
-      "type": "string",
-      "description": "Data Processing Engine definition that aggregates data from one record to another on demand. Available in API version 63.0 and later."
-    },
-    "recordAggregationObject": {
-      "type": "RecordAggregationObject[]",
-      "description": "List of record aggregation objects in the record aggregation join sequence."
-    },
-    "status": {
-      "type": "RecordAggregationDefinitionStatus (enumeration of type string)",
-      "required": true,
-      "description": "Status of this record aggregation definition. Values are: Active Draft Inactive"
-    }
-  },
-  "sub_types": {
-    "RecordAggregationObject": {
-      "associatedObject": {
-        "type": "string",
-        "required": true,
-        "description": "API name of the object associated with this record aggregation object."
-      },
-      "developerName": {
-        "type": "string",
-        "description": "Developer name of the record aggregation object. May contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores."
-      },
-      "filterLogic": {
-        "type": "string",
-        "description": "Logical sequence in which the record aggregation object filters associated with this record aggregation object are applied to the associated object's records. If you define two or more record aggregation object filters, but don’t specify the sequence in which to apply the filters, the filters are applied by using a logical AND expression. Available in API version 60.0 and later."
-      },
-      "masterLabel": {
-        "type": "string",
-        "required": true,
-        "description": "A user-friendly name for RecordAggregationDefinition, which is defined when the RecordAggregationDefinition is created."
-      },
-      "recordAggregationJoinCondition": {
-        "type": "RecordAggregationJoinCondition[]",
-        "description": "List of join conditions that apply to this record aggregation object."
-      },
-      "recordAggregationObjectFilter": {
-        "type": "RecordAggregationObjectFilter[]",
-        "description": "List of filters that are applied to the records of this record aggregation object. Available in API version 60.0 and later."
-      }
-    },
-    "RecordAggregationJoinCondition": {
-      "joinField": {
-        "type": "string",
-        "required": true,
-        "description": "API name of the field on the record aggregation object's associated object that is used in the join condition."
-      },
-      "navigationSequenceNumber": {
-        "type": "int",
-        "required": true,
-        "description": "Sequence number corresponding to this join in the join sequence from the object to which the data is aggregated to the object that contains the data being aggregated."
-      },
-      "relatedJoinField": {
-        "type": "string",
-        "required": true,
-        "description": "API name of the field on the related record aggregation object's associated object that is used in the join condition."
-      },
-      "relatedRecordAggregationObject": {
-        "type": "string",
-        "required": true,
-        "description": "Second record aggregation object in the join condition."
-      },
-      "type": {
-        "type": "RecordAggregationJoinConditionType (enumeration of type string)",
-        "required": true,
-        "description": "Type of this record aggregation join in the join path from the object to which the data is aggregated to the object that contains the data being aggregated. Valid values are: AggregateFrom AggregateTo Intermediate"
-      }
-    },
-    "RecordAggregationObjectFilter": {
-      "associatedObjectField": {
-        "type": "string",
-        "required": true,
-        "description": "API name of the associated object's field whose value is used to filter the object's records. The associated object is specified in the record aggregation object."
-      },
-      "operator": {
-        "type": "RecordAggregationObjectFilterOperator (enumeration of type string)",
-        "required": true,
-        "description": "Operator used in the filter expression. Values are: Contains Equals GreaterThan GreaterThanOrEquals In LessThan LessThanOrEquals NotEquals NotIn"
-      },
-      "sequenceNumber": {
-        "type": "int",
-        "required": true,
-        "description": "Sequence number of this record aggregation object filter."
-      },
-      "value": {
-        "type": "string",
-        "required": true,
-        "description": "Reference value with which the designated field's values are compared when the filter is applied on the associated object's records."
-      }
-    }
-  },
-  "declarative_metadata_sample_definition": [
-    {
-      "description": "The following is an example of a RecordAggregationDefinition component.",
-      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<RecordAggregationDefinition xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n    <aggregateToObject>PartyRelationshipGroup</aggregateToObject>\n    <aggregateFromObject>PartyIncome</aggregateFromObject>\n    <status>Active</status>\n    <aggregationType>Record</aggregationType>\n    <description>Aggregate head of household's income to household</description>\n    <displayName>Party Income to Party Relationship Group</displayName>\n    <recordAggregationObject>\n        <associatedObject>PartyRelationshipGroup</associatedObject>\n        <masterLabel>Party Relationship Group Object</masterLabel>\n        <developerName>PartyRelationshipGroupObject</developerName>\n        <recordAggregationJoinCondition>\n            <joinField>Account</joinField>\n            <navigationSequenceNumber>1</navigationSequenceNumber>\n            <relatedJoinField>Account</relatedJoinField>\n            <relatedRecordAggregationObject>AccountContactrelationObject</relatedRecordAggregationObject>\n            <type>Intermediate</type>\n        </recordAggregationJoinCondition>\n        <recordAggregationObjectFilter>\n          <associatedObjectField>Type</associatedObjectField>\n          <operator>Equals</operator>\n          <value>Household</value>\n          <sequenceNumber>1</sequenceNumber>\n        </recordAggregationObjectFilter>\n    </recordAggregationObject>\n    <recordAggregationObject>\n        <associatedObject>AccountContactRelation</associatedObject>\n        <masterLabel>Account Contact Relation Object</masterLabel>\n        <developerName>AccountContactRelationObject</developerName>\n        <recordAggregationJoinCondition>\n            <joinField>Contact</joinField>\n            <navigationSequenceNumber>2</navigationSequenceNumber>\n            <relatedJoinField>Party</relatedJoinField>\n            <relatedRecordAggregationObject>PartyIncomeObject</relatedRecordAggregationObject>\n            <type>Intermediate</type>\n        </recordAggregationJoinCondition>\n        <recordAggregationObjectFilter>\n          <associatedObjectField>IsPrimaryMember</associatedObjectField>\n          <operator>Equals</operator>\n          <value>true</value>\n          <sequenceNumber>1</sequenceNumber>\n        </recordAggregationObjectFilter>\n    </recordAggregationObject>\n    <recordAggregationObject>\n        <associatedObject>PartyIncome</associatedObject>\n        <masterLabel>Party Income Object</masterLabel>\n        <developerName>PartyIncomeObject</developerName>\n        <filterLogic>1 AND 2</filterLogic>\n        <recordAggregationObjectFilter>\n          <associatedObjectField>IncomeFrequency</associatedObjectField>\n          <operator>Equals</operator>\n          <value>Monthly</value>\n          <sequenceNumber>1</sequenceNumber>\n        </recordAggregationObjectFilter>\n        <recordAggregationObjectFilter>\n          <associatedObjectField>IncomeStatus</associatedObjectField>\n          <operator>Equals</operator>\n          <value>Active</value>\n          <sequenceNumber>2</sequenceNumber>\n        </recordAggregationObjectFilter>\n    </recordAggregationObject>\n</RecordAggregationDefinition>"
-    }
-  ]
-}

package/skills/getting-metadata-api-context/data/metadata_api/RecordAlertCategory.json

@@ -1,42 +0,0 @@
-{
-  "sections": [
-    "title",
-    "description",
-    "file_information",
-    "directory_location",
-    "fields",
-    "wsdl_segment",
-    "declarative_metadata_sample_definition"
-  ],
-  "title": "RecordAlertCategory - Metadata API",
-  "description": "Represents a category to group and present record alerts.",
-  "file_information": ".recordAlertCategory",
-  "directory_location": "recordAlertCategories",
-  "fields_columns": [
-    "type",
-    "description",
-    "required"
-  ],
-  "fields": {
-    "description": {
-      "type": "string",
-      "description": "The description of the record alert category."
-    },
-    "masterLabel": {
-      "type": "string",
-      "required": true,
-      "description": "The user-interface name of the record alert category."
-    },
-    "severity": {
-      "type": "string",
-      "description": "Indicates the degree of impact that an alert in this category can have. Possible Education Cloud values are: High Low Medium Possible Financial Service Cloud values are: Error Info Minor Warning"
-    }
-  },
-  "wsdl_segment": "```xml\n<xsd:complexType name=\"Metadata\">\n  <xsd:sequence>\n    <xsd:element name=\"fullName\" minOccurs=\"0\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"RecordAlertCategory\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"masterLabel\" type=\"xsd:string\"/>\n        <xsd:element name=\"severity\" minOccurs=\"0\" type=\"xsd:string\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n```",
-  "declarative_metadata_sample_definition": [
-    {
-      "description": "The following is an example of a RecordAlertCategory component.",
-      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<RecordAlertCategory xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n    <description>Tracks Financial Account Fraud Alerts</description>\n    <masterLabel>Fraud</masterLabel>\n    <severity>Error</severity>\n</RecordAlertCategory>"
-    }
-  ]
-}

package/skills/getting-metadata-api-context/data/metadata_api/RecordPageSettings.json

@@ -1,40 +0,0 @@
-{
-  "sections": [
-    "title",
-    "description",
-    "file_information",
-    "directory_location",
-    "fields",
-    "wsdl_segment",
-    "declarative_metadata_sample_definition"
-  ],
-  "title": "RecordPageSettings - Metadata API",
-  "description": "Represents an org’s record page settings. This type extends the Metadata metadata type and inherits its fullName field.",
-  "file_information": ".settings",
-  "directory_location": "settings",
-  "fields_columns": [
-    "type",
-    "description"
-  ],
-  "fields": {
-    "enableActivityRelatedList": {
-      "type": "boolean",
-      "description": "Indicates whether the default activities view is related lists (true) or activity timeline (false)."
-    },
-    "enableDynamicForms": {
-      "type": "boolean",
-      "description": "Indicates whether Dynamic Forms is enabled for the org. Removed in API version 50.0 and later."
-    },
-    "enableFullRecordView": {
-      "type": "boolean",
-      "description": "Indicates whether the default record page view is full view (true) or grouped view (false)."
-    }
-  },
-  "wsdl_segment": "```xml\n<xsd:complexType name=\"RecordPageSettings\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"enableActivityRelatedList\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableFullRecordView\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n```",
-  "declarative_metadata_sample_definition": [
-    {
-      "description": "This is a sample recordpage.settings metadata file.",
-      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<RecordPageSettings xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n    <enableDynamicForms>true</enableDynamicForms>\n    <enableActivityRelatedList>true</enableActivityRelatedList>\n    <enableFullRecordView>true</enableFullRecordView>\n</RecordPageSettings>"
-    }
-  ]
-}

package/skills/getting-metadata-api-context/data/metadata_api/RecordType.json

@@ -1,68 +0,0 @@
-{
-  "sections": [
-    "title",
-    "description",
-    "fields",
-    "sub_types",
-    "wsdl_segment",
-    "declarative_metadata_sample_definition"
-  ],
-  "title": "RecordType - Metadata API",
-  "description": "Represents the metadata associated with a record type. Record types let you offer different business processes, picklist values, and page layouts to different users. Use this metadata type to create, update, or delete record type definitions for a custom object.",
-  "fields_columns": [
-    "type",
-    "description"
-  ],
-  "fields": {
-    "active": {
-      "type": "boolean",
-      "description": "Indicates whether the record type is active.",
-      "required": true
-    },
-    "businessProcess": {
-      "type": "string",
-      "description": "The fullName of the business process associated with the record type. This field is required in record types for lead, opportunity, solution, and case, and not allowed otherwise. See BusinessProcess. This field is available in API version 17.0 and later."
-    },
-    "compactLayoutAssignment": {
-      "type": "string",
-      "description": "Represents the compact layout that is assigned to the record type. This field is available in API version 29.0 and later."
-    },
-    "description": {
-      "type": "string",
-      "description": "Record type description. Maximum of 255 characters."
-    },
-    "fullName": {
-      "type": "string",
-      "description": "Record type name. The fullName can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. If this field contained characters before version 14.0 that are no longer allowed, the characters were stripped out of this field, and the previous value of the field was saved in the label field. Inherited from the Metadata component, this field isn’t defined in the WSDL for this component. It must be specified when creating, updating, or deleting. See create() to see an example of this field specified for a call. This value can't be null."
-    },
-    "label": {
-      "type": "string",
-      "description": "Descriptive label for the record type. The list of characters allowed in the fullName field has been reduced for versions 14.0 and later. This field contains the value contained in the fullName field before version 14.0.",
-      "required": true
-    },
-    "picklistValues": {
-      "type": "RecordTypePicklistValue[]",
-      "description": "Represents a set of values for a picklist."
-    }
-  },
-  "sub_types": {
-    "RecordTypePicklistValue": {
-      "picklist": {
-        "type": "string",
-        "description": "The name of the picklist.",
-        "required": true
-      },
-      "values": {
-        "type": "PicklistValue",
-        "description": "One or more of the picklist values in the picklist. Each value defined is available in the record type that contains this component."
-      }
-    }
-  },
-  "wsdl_segment": "```xml\n<xsd:complexType name=\"CustomObject\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"actionOverrides\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ActionOverride\"/>\n        <xsd:element name=\"allowInChatterGroups\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"articleTypeChannelDisplay\" minOccurs=\"0\" type=\"tns:ArticleTypeChannelDisplay\"/>\n        <xsd:element name=\"businessProcesses\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:BusinessProcess\"/>\n        <xsd:element name=\"compactLayoutAssignment\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"compactLayouts\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:CompactLayout\"/>\n        <xsd:element name=\"customHelp\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"customHelpPage\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"customSettingsType\" minOccurs=\"0\" type=\"tns:CustomSettingsType\"/>\n        <xsd:element name=\"deploymentStatus\" minOccurs=\"0\" type=\"tns:DeploymentStatus\"/>\n        <xsd:element name=\"deprecated\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"enableActivities\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableBulkApi\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableDataTranslation\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableDivisions\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableEnhancedLookup\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableFeeds\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableHistory\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableLicensing\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enablePublishStatusTracking\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableReports\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableSearch\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableSharing\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableStreamingApi\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enrichments\" minOccurs=\"0\" type=\"tns:MetadataEnrichments\"/>\n        <xsd:element name=\"eventType\" minOccurs=\"0\" type=\"tns:PlatformEventType\"/>\n        <xsd:element name=\"externalDataSource\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"externalName\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"externalRepository\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"externalSharingModel\" minOccurs=\"0\" type=\"tns:SharingModel\"/>\n        <xsd:element name=\"fieldSets\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:FieldSet\"/>\n        <xsd:element name=\"fields\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:CustomField\"/>\n        <xsd:element name=\"gender\" minOccurs=\"0\" type=\"tns:Gender\"/>\n        <xsd:element name=\"historyRetentionPolicy\" minOccurs=\"0\" type=\"tns:HistoryRetentionPolicy\"/>\n        <xsd:element name=\"household\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"indexes\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:Index\"/>\n        <xsd:element name=\"label\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"listViews\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ListView\"/>\n        <xsd:element name=\"mktDataLakeAttributes\" minOccurs=\"0\" type=\"tns:MktDataLakeAttributes\"/>\n        <xsd:element name=\"mktDataModelAttributes\" minOccurs=\"0\" type=\"tns:MktDataModelAttributes\"/>\n        <xsd:element name=\"nameField\" minOccurs=\"0\" type=\"tns:CustomField\"/>\n        <xsd:element name=\"pluralLabel\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"profileSearchLayouts\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ProfileSearchLayouts\"/>\n        <xsd:element name=\"publishBehavior\" minOccurs=\"0\" type=\"tns:PlatformEventPublishBehavior\"/>\n        <xsd:element name=\"recordTypeTrackFeedHistory\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"recordTypeTrackHistory\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"recordTypes\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:RecordType\"/>\n        <xsd:element name=\"searchLayouts\" minOccurs=\"0\" type=\"tns:SearchLayouts\"/>\n        <xsd:element name=\"sharingModel\" minOccurs=\"0\" type=\"tns:SharingModel\"/>\n        <xsd:element name=\"sharingReasons\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:SharingReason\"/>\n        <xsd:element name=\"sharingRecalculations\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:SharingRecalculation\"/>\n        <xsd:element name=\"startsWith\" minOccurs=\"0\" type=\"tns:StartsWith\"/>\n        <xsd:element name=\"validationRules\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ValidationRule\"/>\n        <xsd:element name=\"visibility\" minOccurs=\"0\" type=\"tns:SetupObjectVisibility\"/>\n        <xsd:element name=\"webLinks\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:WebLink\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:simpleType name=\"ForecastCategories\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"Omitted\"/>\n    <xsd:enumeration value=\"Pipeline\"/>\n    <xsd:enumeration value=\"BestCase\"/>\n    <xsd:enumeration value=\"MostLikely\"/>\n    <xsd:enumeration value=\"Forecast\"/>\n    <xsd:enumeration value=\"Closed\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"Metadata\">\n  <xsd:sequence>\n    <xsd:element name=\"fullName\" minOccurs=\"0\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"PicklistValue\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"color\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"default\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"isActive\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"allowEmail\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"closed\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"controllingFieldValues\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"xsd:string\"/>\n        <xsd:element name=\"converted\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"cssExposed\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"forecastCategory\" minOccurs=\"0\" type=\"tns:ForecastCategories\"/>\n        <xsd:element name=\"highPriority\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"probability\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <xsd:element name=\"reverseRole\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"reviewed\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"won\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"RecordType\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"active\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"businessProcess\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"compactLayoutAssignment\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"label\" type=\"xsd:string\"/>\n        <xsd:element name=\"picklistValues\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:RecordTypePicklistValue\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"RecordTypePicklistValue\">\n  <xsd:sequence>\n    <xsd:element name=\"picklist\" type=\"xsd:string\"/>\n    <xsd:element name=\"values\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:PicklistValue\"/>\n  </xsd:sequence>\n</xsd:complexType>\n```",
-  "declarative_metadata_sample_definition": [
-    {
-      "description": "The definition of a record type in a custom object is shown in this code block.",
-      "code": "<CustomObject xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n. . .\n   <recordTypes>\n        <fullName>My First Recordtype</fullName>\n    </recordTypes>\n . . .\n</CustomObject>"
-    }
-  ]
-}

package/skills/getting-metadata-api-context/data/metadata_api/RedirectWhitelistUrl.json

@@ -1,26 +0,0 @@
-{
-  "sections": [
-    "title",
-    "description",
-    "file_information",
-    "directory_location",
-    "fields",
-    "wsdl_segment"
-  ],
-  "title": "RedirectWhitelistUrl - Metadata API",
-  "description": "Represents a trusted URL that’s excluded from redirection restrictions when the redirectionWarning or redirectBlockModeEnabled field on the SessionSettings Metadata type is set to true. This type extends the Metadata metadata type and inherits its fullName field.",
-  "file_information": ".redirectWhitelistUrl",
-  "directory_location": "redirectWhitelistUrls",
-  "fields_columns": [
-    "type",
-    "description"
-  ],
-  "fields": {
-    "url": {
-      "type": "string",
-      "description": "The trusted URL. These formats are accepted: example.com, *.example.com, and https://example.com. The host section of the URL can include an asterisk (*) as a wildcard. Otherwise, the URL cannot be malformed. Examples of malformed URLs that fail a syntax check are malformed^url.example.com, and https://{subdomain}.example.com. To add a URL based on parameters, build the URL before you add it to this Metadata Type.",
-      "required": true
-    }
-  },
-  "wsdl_segment": "```xml\n<xsd:complexType name=\"Metadata\">\n  <xsd:sequence>\n    <xsd:element name=\"fullName\" minOccurs=\"0\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"RedirectWhitelistUrl\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"url\" type=\"xsd:string\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n```"
-}

package/skills/getting-metadata-api-context/data/metadata_api/ReferencedDashboard.json

@@ -1,55 +0,0 @@
-{
-  "sections": [
-    "title",
-    "description",
-    "file_information",
-    "directory_location",
-    "fields",
-    "wsdl_segment",
-    "declarative_metadata_sample_definition"
-  ],
-  "title": "ReferencedDashboard - Metadata API",
-  "description": "Represents the ReferencedDashboard object in CRM Analytics. A referenced dashboard stores information about an externally referenced dashboard.",
-  "file_information": ".refdash",
-  "directory_location": "wave",
-  "fields_columns": [
-    "type",
-    "description"
-  ],
-  "fields": {
-    "application": {
-      "type": "string",
-      "description": "The internal name of the Analytics app.",
-      "required": true
-    },
-    "description": {
-      "type": "string",
-      "description": "The dashboard description that appears in the user interface."
-    },
-    "embedUrl": {
-      "type": "string",
-      "description": "The URL to the referenced dashboard.",
-      "required": true
-    },
-    "masterLabel": {
-      "type": "string",
-      "description": "The dashboard name that appears in the user interface.",
-      "required": true
-    },
-    "templateAssetSourceName": {
-      "type": "string",
-      "description": "Links the dashboard to the template used to create it. Null for assets not created from a template."
-    },
-    "visibility": {
-      "type": "string",
-      "description": "The visibility of the dashboard. Valid values are: ALL and LIMITED."
-    }
-  },
-  "wsdl_segment": "```xml\n<xsd:complexType name=\"Metadata\">\n  <xsd:sequence>\n    <xsd:element name=\"fullName\" minOccurs=\"0\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"ReferencedDashboard\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"application\" type=\"xsd:string\"/>\n        <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"embedUrl\" type=\"xsd:string\"/>\n        <xsd:element name=\"masterLabel\" type=\"xsd:string\"/>\n        <xsd:element name=\"templateAssetSourceName\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"visibility\" type=\"xsd:string\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n```",
-  "declarative_metadata_sample_definition": [
-    {
-      "description": "The following is an example of a WaveDashboard component.",
-      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ReferencedDashboard xmlns=\"http://soap.sforce.com/2006/04/metadata\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">\n    <application>my_app</application>\n    <masterLabel>ReferencedDashboard1</masterLabel>\n    <description>My Tableau Dashboard</description>\n    <embedUrl>https://public.tableau.com/views/Superstore_24/Overview</embedUrl>\n    <visibility>ALL</visibility>\n</ReferencedDashboard>"
-    }
-  ]
-}