mcdev 4.3.4 → 5.0.0

package/lib/metadataTypes/definitions/MobileMessage.definition.js

@@ -0,0 +1,743 @@
+module.exports = {
+    bodyIteratorField: 'entry',
+    dependencies: ['mobileCode', 'mobileKeyword', 'campaign'],
+    hasExtended: false,
+    idField: 'id',
+    keepId: true,
+    keyIsFixed: true, // key == id
+    keyField: 'id',
+    nameField: 'name',
+    createdDateField: null,
+    createdNameField: null,
+    lastmodDateField: 'lastUpdated',
+    lastmodNameField: null,
+    restPagination: true,
+    restPageSize: 50,
+    type: 'mobileMessage',
+    typeDescription:
+        'Used by Journey Builder and to send SMS from MobileConnect triggered by API or manually on-the-fly',
+    typeRetrieveByDefault: true,
+    typeName: 'MobileConnect SMS',
+    fields: {
+        allowSingleOptin: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        audience: {
+            skipValidation: true,
+        },
+        'audience[]': {
+            skipValidation: true,
+        },
+        campaigns: {
+            skipValidation: true,
+        },
+        'campaigns[]': {
+            skipValidation: true,
+        },
+        'code.code': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        'code.codeType': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'code.countryCode': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'code.createdDate': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'code.dipSwitches': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'code.endDate': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'code.id': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'code.isClientOwned': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'code.isGsmCharacterSetOnly': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'code.isMms': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'code.isOwner': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'code.isShortCode': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'code.isStackIndependant': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'code.keywordLimit': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'code.keywordsUsed': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'code.keywordsUsedOther': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'code.lastUpdated': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'code.moEngineVersion': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'code.sendableCountries': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'code.sendableCountries[]': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'code.sendableCountries[].countryCode': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'code.sendableCountries[].vendor': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'code.sendableCountries[].fromNameSupported': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'code.startDate': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'code.supportsConcatenation': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        concatenateMessage: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        currentEditStep: {
+            isCreatable: false,
+            isUpdatable: false,
+            retrieving: false,
+            template: false,
+        },
+        doubleOptinConfirmMessage: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        doubleOptinInitialMessage: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        doubleOptinValidResponses: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        duplicateOptInResponseMessage: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        expireHours: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        fromName: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        id: {
+            isCreateable: false,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        invalidMessage: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        isCertified: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        isDuplicationAllowed: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        isExpireSet: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        isFromNameCertificationAccepted: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        isSentImmediately: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        isSubscriberResponseToAnySubscriptionForShortCode: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        isSuppressMt: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        isTest: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        isTimeZoneBased: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        'keyword.id': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'keyword.isInherited': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'keyword.keyword': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        'keyword.keywordType': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'keyword.restriction': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        lastUpdated: {
+            isCreateable: false,
+            isUpdateable: true,
+            retrieving: true,
+            template: false,
+        },
+        messageObjectId: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        messagesPerPeriod: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        minutesPerPeriod: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        moStartDate: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        moEndDate: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        'moTimezone.name': {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        'moTimezone.offset': {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        'mtRecurrence.id': {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        'mtRecurrence.key': {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        'mtRecurrence.createdDate': {
+            isCreatable: false,
+            isUpdatable: false,
+            retrieving: true,
+            template: false,
+        },
+        'mtRecurrence.createdBy': {
+            isCreatable: false,
+            isUpdatable: false,
+            retrieving: false,
+            template: false,
+        },
+        'mtRecurrence.lastUpdated': {
+            isCreatable: false,
+            isUpdatable: false,
+            retrieving: true,
+            template: false,
+        },
+        'mtRecurrence.lastUpdatedBy': {
+            isCreatable: false,
+            isUpdatable: false,
+            retrieving: false,
+            template: false,
+        },
+        'mtRecurrence.name': {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        'mtRecurrence.description': {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        'mtRecurrence.startDate': {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        'mtRecurrence.iCalRecur': {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        'mtRecurrence.timeZone': {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        'mtRecurrence.timeZoneId': {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        mtSendDate: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        name: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        nextJob: {
+            // contains lots of info but deemed not needed for retrieving or deploying
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        nextKeyword: {
+            // contains lots of info but deemed not needed for retrieving or deploying
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        numberMessagesPerPeriod: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        optinErrorMessage: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        optinInvalidAgeMessage: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        optinMinimumAge: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        optinType: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        origin: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        outboundSendBehaviorFlag: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        outboundSendTypeFlag: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        periodType: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        programId: {
+            // always "00000000-0000-0000-0000-000000000000"
+            isCreatable: false,
+            isUpdatable: false,
+            retrieving: false,
+            template: false,
+        },
+        publishedMessage: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        responseMessage: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        sendMethod: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        smsTriggeredSendDefinitionId: {
+            // if no value then it's set to "00000000-0000-0000-0000-000000000000"
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        statistics: {
+            // not relevant for deployment or configuration
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        'statistics.outbound': {
+            // not relevant for deployment or configuration
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        'statistics.outbound.sent': {
+            // not relevant for deployment or configuration
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        'statistics.outbound.delivered': {
+            // not relevant for deployment or configuration
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        'statistics.outbound.undelivered': {
+            // not relevant for deployment or configuration
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        'statistics.outbound.unknown': {
+            // not relevant for deployment or configuration
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        status: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        statusId: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        'subscriptionKeyword.id': {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        'subscriptionKeyword.keyword': {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        'subscriptionKeyword.restriction': {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        'subscriptionKeyword.isInherited': {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        subscriberResponseMessage: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        surveyCorrectResponseMessage: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        surveyIncorrectResponseMessage: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        surveyResponsesAllowed: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        surveyTooManyEntriesMessage: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        surveyType: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        'template.description': {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        'template.icon': {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        'template.id': {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        'template.lastUpdated': {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        'template.name': {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        text: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        triggeredSendId: {
+            // always "00000000-0000-0000-0000-000000000000"
+            isCreatable: false,
+            isUpdatable: false,
+            retrieving: false,
+            template: false,
+        },
+        triggeredSendName: {
+            isCreatable: true,
+            isUpdatable: true,
+            retrieving: true,
+            template: true,
+        },
+        type: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        c__campaignNames: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+        'c__campaignNames[]': { skipValidation: true },
+    },
+};