Documentation

    
{
    "$defs": {
        "SAMAccountMetadata": {
            "description": "Smarter API Account Manifest - Metadata class.",
            "properties": {
                "name": {
                    "description": "The camelCase name of the manifest resource",
                    "title": "Name",
                    "type": "string"
                },
                "description": {
                    "description": "The description for this resource. Be brief. Keep it under 255 characters.",
                    "title": "Description",
                    "type": "string"
                },
                "version": {
                    "description": "The semantic version of the manifest. Example: 0.1.0",
                    "title": "Version",
                    "type": "string"
                },
                "tags": {
                    "anyOf": [
                        {
                            "items": {
                                "type": "string"
                            },
                            "type": "array"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "default": null,
                    "description": "The tags of the manifest. These are fully functional but are not currently used. Example: [tag1, tag2]",
                    "title": "Tags"
                },
                "annotations": {
                    "anyOf": [
                        {
                            "items": {
                                "type": "string"
                            },
                            "type": "array"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "default": null,
                    "description": "The manifest annotations. These are fully functional but are not currently used.",
                    "title": "Annotations"
                },
                "accountNumber": {
                    "description": "Account.metadata.accountNumber[str]. Your preassigned 12-digit account number for your Smarter Account in the format ####-####-####. Read only.",
                    "title": "Accountnumber",
                    "type": "string"
                }
            },
            "required": [
                "name",
                "description",
                "version",
                "accountNumber"
            ],
            "title": "SAMAccountMetadata",
            "type": "object"
        },
        "SAMAccountSpec": {
            "description": "Smarter API Account Manifest Account.spec",
            "properties": {
                "config": {
                    "$ref": "#/$defs/SAMAccountSpecConfig",
                    "description": "Account.spec.config[object]. The configuration for the Account."
                }
            },
            "required": [
                "config"
            ],
            "title": "SAMAccountSpec",
            "type": "object"
        },
        "SAMAccountSpecConfig": {
            "description": "Smarter API Account Manifest Account.spec.config",
            "properties": {
                "companyName": {
                    "description": "Account.spec.configuration.companyName[str]. The legal entity of your Smarter Account for invoicing and legal correspondence.",
                    "title": "Companyname",
                    "type": "string"
                },
                "phoneNumber": {
                    "description": "Account.spec.configuration.phoneNumber[str]. The primary phone number for the Account.",
                    "title": "Phonenumber",
                    "type": "string"
                },
                "address1": {
                    "description": "Account.spec.configuration.address1[str]. The primary address for the Account.",
                    "title": "Address1",
                    "type": "string"
                },
                "address2": {
                    "anyOf": [
                        {
                            "type": "string"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "default": null,
                    "description": "Account.spec.configuration.address2[str]. Optional. The secondary address for the Account.",
                    "title": "Address2"
                },
                "city": {
                    "description": "Account.spec.configuration.city[str]. The city for the Account.",
                    "title": "City",
                    "type": "string"
                },
                "state": {
                    "description": "Account.spec.configuration.state[str]. The state for the Account.",
                    "title": "State",
                    "type": "string"
                },
                "postalCode": {
                    "description": "Account.spec.configuration.postalCode[str]. The postal code for the Account.",
                    "title": "Postalcode",
                    "type": "string"
                },
                "country": {
                    "description": "Account.spec.configuration.country[str]. The country for the Account.",
                    "title": "Country",
                    "type": "string"
                },
                "language": {
                    "description": "Account.spec.configuration.language[str]. The primary language for the Account.",
                    "title": "Language",
                    "type": "string"
                },
                "timezone": {
                    "description": "Account.spec.configuration.timezone[str]. The primary timezone for the Account.",
                    "title": "Timezone",
                    "type": "string"
                },
                "currency": {
                    "description": "Account.spec.configuration.currency[str]. The primary currency for the Account.",
                    "title": "Currency",
                    "type": "string"
                }
            },
            "required": [
                "companyName",
                "phoneNumber",
                "address1",
                "city",
                "state",
                "postalCode",
                "country",
                "language",
                "timezone",
                "currency"
            ],
            "title": "SAMAccountSpecConfig",
            "type": "object"
        },
        "SAMAccountStatus": {
            "description": "Smarter API Account Manifest - Status class.",
            "properties": {
                "adminAccount": {
                    "default": null,
                    "description": "Account.status.adminAccount: The designated Smarter admin user for this Account. Read only.",
                    "title": "Adminaccount",
                    "type": "string"
                },
                "created": {
                    "default": null,
                    "description": "Account.status.created: The date in which this Account was created. Read only.",
                    "format": "date-time",
                    "title": "Created",
                    "type": "string"
                },
                "modified": {
                    "default": null,
                    "description": "Account.status.modified: The date in which this Account was most recently changed. Read only.",
                    "format": "date-time",
                    "title": "Modified",
                    "type": "string"
                }
            },
            "title": "SAMAccountStatus",
            "type": "object"
        }
    },
    "description": "Smarter API Manifest - Account",
    "properties": {
        "apiVersion": {
            "description": "apiVersion[String]: Required. The API version of the AbstractSAMBase.",
            "title": "Apiversion",
            "type": "string"
        },
        "kind": {
            "description": "kind[String]: Required. The kind of resource described by the manifest.",
            "title": "Kind",
            "type": "string"
        },
        "metadata": {
            "$ref": "#/$defs/SAMAccountMetadata",
            "description": "Account.metadata[obj]: Required, the Account metadata."
        },
        "spec": {
            "$ref": "#/$defs/SAMAccountSpec",
            "description": "Account.spec[obj]: Required, the Account specification."
        },
        "status": {
            "anyOf": [
                {
                    "$ref": "#/$defs/SAMAccountStatus"
                },
                {
                    "type": "null"
                }
            ],
            "description": "Account.status[obj]: Optional, Read-only. Stateful status information about the Account."
        }
    },
    "required": [
        "apiVersion",
        "kind",
        "metadata",
        "spec",
        "status"
    ],
    "title": "SAMAccount",
    "type": "object"
}