UNPKG

@sphereon/ssi-sdk.issuance-branding

Version:

1,219 lines (1,218 loc) • 36 kB
{ "IIssuanceBranding": { "components": { "schemas": { "IAddCredentialBrandingArgs": { "type": "object", "properties": { "issuerCorrelationId": { "type": "string" }, "vcHash": { "type": "string" }, "localeBranding": { "type": "array", "items": { "$ref": "#/components/schemas/IBasicCredentialLocaleBranding" } } }, "required": ["issuerCorrelationId", "vcHash", "localeBranding"], "additionalProperties": false }, "IBasicCredentialLocaleBranding": { "type": "object", "properties": { "alias": { "type": "string" }, "locale": { "type": "string" }, "description": { "type": "string" }, "logo": { "$ref": "#/components/schemas/IBasicImageAttributes" }, "background": { "$ref": "#/components/schemas/IBasicBackgroundAttributes" }, "text": { "$ref": "#/components/schemas/IBasicTextAttributes" }, "claims": { "type": "array", "items": { "$ref": "#/components/schemas/IBasicCredentialClaim" } } }, "additionalProperties": false }, "IBasicImageAttributes": { "type": "object", "properties": { "uri": { "type": "string" }, "dataUri": { "type": "string" }, "mediaType": { "type": "string" }, "alt": { "type": "string" }, "dimensions": { "$ref": "#/components/schemas/IBasicImageDimensions" } }, "additionalProperties": false }, "IBasicImageDimensions": { "type": "object", "additionalProperties": false, "properties": { "width": { "type": "number" }, "height": { "type": "number" } }, "required": ["height", "width"] }, "IBasicBackgroundAttributes": { "type": "object", "properties": { "color": { "type": "string" }, "image": { "$ref": "#/components/schemas/IBasicImageAttributes" } }, "additionalProperties": false }, "IBasicTextAttributes": { "type": "object", "additionalProperties": false, "properties": { "color": { "type": "string" } } }, "IBasicCredentialClaim": { "type": "object", "additionalProperties": false, "properties": { "key": { "type": "string" }, "name": { "type": "string" } }, "required": ["key", "name"] }, "ICredentialBranding": { "type": "object", "properties": { "id": { "type": "string" }, "issuerCorrelationId": { "type": "string" }, "vcHash": { "type": "string" }, "localeBranding": { "type": "array", "items": { "$ref": "#/components/schemas/ICredentialLocaleBranding" } }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdatedAt": { "type": "string", "format": "date-time" } }, "required": ["id", "issuerCorrelationId", "vcHash", "localeBranding", "createdAt", "lastUpdatedAt"], "additionalProperties": false }, "ICredentialLocaleBranding": { "type": "object", "properties": { "id": { "type": "string" }, "alias": { "type": "string" }, "locale": { "type": "string" }, "logo": { "$ref": "#/components/schemas/IImageAttributes" }, "description": { "type": "string" }, "background": { "$ref": "#/components/schemas/IBackgroundAttributes" }, "text": { "$ref": "#/components/schemas/ITextAttributes" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "claims": { "type": "array", "items": { "$ref": "#/components/schemas/ICredentialClaim" } } }, "additionalProperties": false, "required": ["createdAt", "id", "lastUpdatedAt"] }, "IImageAttributes": { "type": "object", "properties": { "id": { "type": "string" }, "uri": { "type": "string" }, "dataUri": { "type": "string" }, "mediaType": { "type": "string" }, "alt": { "type": "string" }, "dimensions": { "$ref": "#/components/schemas/IImageDimensions" } }, "required": ["id"], "additionalProperties": false }, "IImageDimensions": { "type": "object", "properties": { "id": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" } }, "required": ["id", "width", "height"], "additionalProperties": false }, "IBackgroundAttributes": { "type": "object", "properties": { "id": { "type": "string" }, "color": { "type": "string" }, "image": { "$ref": "#/components/schemas/IImageAttributes" } }, "required": ["id"], "additionalProperties": false }, "ITextAttributes": { "type": "object", "properties": { "id": { "type": "string" }, "color": { "type": "string" } }, "required": ["id"], "additionalProperties": false }, "ICredentialClaim": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" } }, "required": ["id", "key", "name"], "additionalProperties": false }, "IAddCredentialLocaleBrandingArgs": { "type": "object", "properties": { "credentialBrandingId": { "type": "string" }, "localeBranding": { "type": "array", "items": { "$ref": "#/components/schemas/IBasicCredentialLocaleBranding" } } }, "required": ["credentialBrandingId", "localeBranding"], "additionalProperties": false }, "IAddIssuerBrandingArgs": { "type": "object", "properties": { "issuerCorrelationId": { "type": "string" }, "localeBranding": { "type": "array", "items": { "$ref": "#/components/schemas/IBasicIssuerLocaleBranding" } } }, "required": ["issuerCorrelationId", "localeBranding"], "additionalProperties": false }, "IBasicIssuerLocaleBranding": { "type": "object", "properties": { "clientUri": { "type": "string" }, "tosUri": { "type": "string" }, "policyUri": { "type": "string" }, "contacts": { "type": "array", "items": { "type": "string" } }, "alias": { "type": "string" }, "locale": { "type": "string" }, "description": { "type": "string" }, "logo": { "$ref": "#/components/schemas/IBasicImageAttributes" }, "background": { "$ref": "#/components/schemas/IBasicBackgroundAttributes" }, "text": { "$ref": "#/components/schemas/IBasicTextAttributes" } }, "additionalProperties": false }, "IIssuerBranding": { "type": "object", "properties": { "id": { "type": "string" }, "issuerCorrelationId": { "type": "string" }, "localeBranding": { "type": "array", "items": { "$ref": "#/components/schemas/IIssuerLocaleBranding" } }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdatedAt": { "type": "string", "format": "date-time" } }, "required": ["id", "issuerCorrelationId", "localeBranding", "createdAt", "lastUpdatedAt"], "additionalProperties": false }, "IIssuerLocaleBranding": { "type": "object", "properties": { "id": { "type": "string" }, "alias": { "type": "string" }, "locale": { "type": "string" }, "logo": { "$ref": "#/components/schemas/IImageAttributes" }, "description": { "type": "string" }, "background": { "$ref": "#/components/schemas/IBackgroundAttributes" }, "text": { "$ref": "#/components/schemas/ITextAttributes" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "clientUri": { "type": "string" }, "tosUri": { "type": "string" }, "policyUri": { "type": "string" }, "contacts": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": ["createdAt", "id", "lastUpdatedAt"] }, "IAddIssuerLocaleBrandingArgs": { "type": "object", "properties": { "issuerBrandingId": { "type": "string" }, "localeBranding": { "type": "array", "items": { "$ref": "#/components/schemas/IBasicIssuerLocaleBranding" } } }, "required": ["issuerBrandingId", "localeBranding"], "additionalProperties": false }, "ICredentialBrandingFromArgs": { "type": "object", "properties": { "localeBranding": { "$ref": "#/components/schemas/IBasicCredentialLocaleBranding" } }, "required": ["localeBranding"], "additionalProperties": false }, "IGetCredentialBrandingArgs": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/FindCredentialBrandingArgs" } }, "additionalProperties": false }, "FindCredentialBrandingArgs": { "type": "array", "items": { "$ref": "#/components/schemas/ICredentialBrandingFilter" } }, "ICredentialBrandingFilter": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "issuerCorrelationId": { "type": "string" }, "vcHash": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "localeBranding": { "$ref": "#/components/schemas/IPartialCredentialLocaleBranding" } } }, "IPartialCredentialLocaleBranding": { "type": "object", "properties": { "id": { "type": "string" }, "alias": { "type": "string" }, "locale": { "type": "string" }, "description": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "logo": { "$ref": "#/components/schemas/IPartialImageAttributes" }, "background": { "$ref": "#/components/schemas/IPartialBackgroundAttributes" }, "text": { "$ref": "#/components/schemas/IPartialTextAttributes" }, "claims": { "$ref": "#/components/schemas/IPartialCredentialClaim" } }, "additionalProperties": false }, "IPartialImageAttributes": { "type": "object", "properties": { "id": { "type": "string" }, "uri": { "type": "string" }, "dataUri": { "type": "string" }, "mediaType": { "type": "string" }, "alt": { "type": "string" }, "dimensions": { "$ref": "#/components/schemas/IPartialImageDimensions" } }, "additionalProperties": false }, "IPartialImageDimensions": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" } } }, "IPartialBackgroundAttributes": { "type": "object", "properties": { "id": { "type": "string" }, "color": { "type": "string" }, "image": { "$ref": "#/components/schemas/IPartialImageAttributes" } }, "additionalProperties": false }, "IPartialTextAttributes": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "color": { "type": "string" } } }, "IPartialCredentialClaim": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" } } }, "IGetCredentialLocaleBrandingArgs": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/FindCredentialLocaleBrandingArgs" } }, "additionalProperties": false }, "FindCredentialLocaleBrandingArgs": { "type": "array", "items": { "$ref": "#/components/schemas/ICredentialLocaleBrandingFilter" } }, "ICredentialLocaleBrandingFilter": { "type": "object", "properties": { "id": { "type": "string" }, "alias": { "type": "string" }, "locale": { "type": "string" }, "description": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "logo": { "$ref": "#/components/schemas/IPartialImageAttributes" }, "background": { "$ref": "#/components/schemas/IPartialBackgroundAttributes" }, "text": { "$ref": "#/components/schemas/IPartialTextAttributes" }, "claims": { "$ref": "#/components/schemas/IPartialCredentialClaim" }, "credentialBranding": { "$ref": "#/components/schemas/IPartialCredentialBranding" } }, "additionalProperties": false }, "IPartialCredentialBranding": { "type": "object", "properties": { "id": { "type": "string" }, "issuerCorrelationId": { "type": "string" }, "vcHash": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "localeBranding": { "$ref": "#/components/schemas/IPartialCredentialLocaleBranding" } }, "additionalProperties": false }, "IGetIssuerBrandingArgs": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/FindIssuerBrandingArgs" } }, "additionalProperties": false }, "FindIssuerBrandingArgs": { "type": "array", "items": { "$ref": "#/components/schemas/IIssuerBrandingFilter" } }, "IIssuerBrandingFilter": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "issuerCorrelationId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "localeBranding": { "$ref": "#/components/schemas/IPartialIssuerLocaleBranding" } } }, "IPartialIssuerLocaleBranding": { "type": "object", "properties": { "clientUri": { "type": "string" }, "tosUri": { "type": "string" }, "policyUri": { "type": "string" }, "id": { "type": "string" }, "alias": { "type": "string" }, "locale": { "type": "string" }, "description": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "logo": { "$ref": "#/components/schemas/IPartialImageAttributes" }, "background": { "$ref": "#/components/schemas/IPartialBackgroundAttributes" }, "text": { "$ref": "#/components/schemas/IPartialTextAttributes" }, "contacts": { "type": "string" } }, "additionalProperties": false }, "IGetIssuerLocaleBrandingArgs": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/FindIssuerLocaleBrandingArgs" } }, "additionalProperties": false }, "FindIssuerLocaleBrandingArgs": { "type": "array", "items": { "$ref": "#/components/schemas/IIssuerLocaleBrandingFilter" } }, "IIssuerLocaleBrandingFilter": { "type": "object", "properties": { "clientUri": { "type": "string" }, "tosUri": { "type": "string" }, "policyUri": { "type": "string" }, "id": { "type": "string" }, "alias": { "type": "string" }, "locale": { "type": "string" }, "description": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "logo": { "$ref": "#/components/schemas/IPartialImageAttributes" }, "background": { "$ref": "#/components/schemas/IPartialBackgroundAttributes" }, "text": { "$ref": "#/components/schemas/IPartialTextAttributes" }, "contacts": { "type": "string" }, "issuerBranding": { "$ref": "#/components/schemas/IPartialIssuerBranding" } }, "additionalProperties": false }, "IPartialIssuerBranding": { "type": "object", "properties": { "id": { "type": "string" }, "issuerCorrelationId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "localeBranding": { "$ref": "#/components/schemas/IPartialIssuerLocaleBranding" } }, "additionalProperties": false }, "IIssuerBrandingFromArgs": { "type": "object", "properties": { "localeBranding": { "$ref": "#/components/schemas/IBasicIssuerLocaleBranding" } }, "required": ["localeBranding"], "additionalProperties": false }, "IRemoveCredentialBrandingArgs": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/FindCredentialBrandingArgs" } }, "required": ["filter"], "additionalProperties": false }, "IDeletionResult": { "type": "object", "properties": { "result": { "type": "boolean" }, "error": { "type": "string" } }, "required": ["result"], "additionalProperties": false }, "IRemoveCredentialLocaleBrandingArgs": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/FindCredentialLocaleBrandingArgs" } }, "required": ["filter"], "additionalProperties": false }, "IRemoveIssuerBrandingArgs": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/FindIssuerBrandingArgs" } }, "required": ["filter"], "additionalProperties": false }, "IRemoveIssuerLocaleBrandingArgs": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/FindIssuerLocaleBrandingArgs" } }, "required": ["filter"], "additionalProperties": false }, "IUpdateCredentialBrandingArgs": { "type": "object", "properties": { "credentialBranding": { "$ref": "#/components/schemas/Omit<ICredentialBranding,(\"localeBranding\"|\"createdAt\"|\"lastUpdatedAt\")>" } }, "required": ["credentialBranding"], "additionalProperties": false }, "Omit<ICredentialBranding,(\"localeBranding\"|\"createdAt\"|\"lastUpdatedAt\")>": { "$ref": "#/components/schemas/Pick<ICredentialBranding,Exclude<(\"id\"|\"issuerCorrelationId\"|\"vcHash\"|\"localeBranding\"|\"createdAt\"|\"lastUpdatedAt\"),(\"localeBranding\"|\"createdAt\"|\"lastUpdatedAt\")>>" }, "Pick<ICredentialBranding,Exclude<(\"id\"|\"issuerCorrelationId\"|\"vcHash\"|\"localeBranding\"|\"createdAt\"|\"lastUpdatedAt\"),(\"localeBranding\"|\"createdAt\"|\"lastUpdatedAt\")>>": { "type": "object", "properties": { "id": { "type": "string" }, "issuerCorrelationId": { "type": "string" }, "vcHash": { "type": "string" } }, "required": ["id", "issuerCorrelationId", "vcHash"], "additionalProperties": false }, "IUpdateCredentialLocaleBrandingArgs": { "type": "object", "properties": { "localeBranding": { "$ref": "#/components/schemas/Omit<ILocaleBranding,(\"createdAt\"|\"lastUpdatedAt\")>" } }, "required": ["localeBranding"], "additionalProperties": false }, "Omit<ILocaleBranding,(\"createdAt\"|\"lastUpdatedAt\")>": { "$ref": "#/components/schemas/Pick<ILocaleBranding,Exclude<(\"id\"|\"alias\"|\"locale\"|\"logo\"|\"description\"|\"background\"|\"text\"|\"createdAt\"|\"lastUpdatedAt\"),(\"createdAt\"|\"lastUpdatedAt\")>>" }, "Pick<ILocaleBranding,Exclude<(\"id\"|\"alias\"|\"locale\"|\"logo\"|\"description\"|\"background\"|\"text\"|\"createdAt\"|\"lastUpdatedAt\"),(\"createdAt\"|\"lastUpdatedAt\")>>": { "type": "object", "properties": { "id": { "type": "string" }, "alias": { "type": "string" }, "locale": { "type": "string" }, "logo": { "$ref": "#/components/schemas/IImageAttributes" }, "description": { "type": "string" }, "background": { "$ref": "#/components/schemas/IBackgroundAttributes" }, "text": { "$ref": "#/components/schemas/ITextAttributes" } }, "required": ["id"], "additionalProperties": false }, "IUpdateIssuerBrandingArgs": { "type": "object", "properties": { "issuerBranding": { "$ref": "#/components/schemas/Omit<IIssuerBranding,(\"localeBranding\"|\"createdAt\"|\"lastUpdatedAt\")>" } }, "required": ["issuerBranding"], "additionalProperties": false }, "Omit<IIssuerBranding,(\"localeBranding\"|\"createdAt\"|\"lastUpdatedAt\")>": { "$ref": "#/components/schemas/Pick<IIssuerBranding,Exclude<(\"id\"|\"issuerCorrelationId\"|\"localeBranding\"|\"createdAt\"|\"lastUpdatedAt\"),(\"localeBranding\"|\"createdAt\"|\"lastUpdatedAt\")>>" }, "Pick<IIssuerBranding,Exclude<(\"id\"|\"issuerCorrelationId\"|\"localeBranding\"|\"createdAt\"|\"lastUpdatedAt\"),(\"localeBranding\"|\"createdAt\"|\"lastUpdatedAt\")>>": { "type": "object", "properties": { "id": { "type": "string" }, "issuerCorrelationId": { "type": "string" } }, "required": ["id", "issuerCorrelationId"], "additionalProperties": false }, "IUpdateIssuerLocaleBrandingArgs": { "type": "object", "properties": { "localeBranding": { "$ref": "#/components/schemas/Omit<ILocaleBranding,(\"createdAt\"|\"lastUpdatedAt\")>" } }, "required": ["localeBranding"], "additionalProperties": false } }, "methods": { "ibAddCredentialBranding": { "description": "", "arguments": { "$ref": "#/components/schemas/IAddCredentialBrandingArgs" }, "returnType": { "$ref": "#/components/schemas/ICredentialBranding" } }, "ibAddCredentialLocaleBranding": { "description": "", "arguments": { "$ref": "#/components/schemas/IAddCredentialLocaleBrandingArgs" }, "returnType": { "$ref": "#/components/schemas/ICredentialBranding" } }, "ibAddIssuerBranding": { "description": "", "arguments": { "$ref": "#/components/schemas/IAddIssuerBrandingArgs" }, "returnType": { "$ref": "#/components/schemas/IIssuerBranding" } }, "ibAddIssuerLocaleBranding": { "description": "", "arguments": { "$ref": "#/components/schemas/IAddIssuerLocaleBrandingArgs" }, "returnType": { "$ref": "#/components/schemas/IIssuerBranding" } }, "ibCredentialLocaleBrandingFrom": { "description": "", "arguments": { "$ref": "#/components/schemas/ICredentialBrandingFromArgs" }, "returnType": { "$ref": "#/components/schemas/IBasicCredentialLocaleBranding" } }, "ibGetCredentialBranding": { "description": "", "arguments": { "$ref": "#/components/schemas/IGetCredentialBrandingArgs" }, "returnType": { "type": "array", "items": { "$ref": "#/components/schemas/ICredentialBranding" } } }, "ibGetCredentialLocaleBranding": { "description": "", "arguments": { "$ref": "#/components/schemas/IGetCredentialLocaleBrandingArgs" }, "returnType": { "type": "array", "items": { "$ref": "#/components/schemas/ICredentialLocaleBranding" } } }, "ibGetIssuerBranding": { "description": "", "arguments": { "$ref": "#/components/schemas/IGetIssuerBrandingArgs" }, "returnType": { "type": "array", "items": { "$ref": "#/components/schemas/IIssuerBranding" } } }, "ibGetIssuerLocaleBranding": { "description": "", "arguments": { "$ref": "#/components/schemas/IGetIssuerLocaleBrandingArgs" }, "returnType": { "type": "array", "items": { "$ref": "#/components/schemas/IIssuerLocaleBranding" } } }, "ibIssuerLocaleBrandingFrom": { "description": "", "arguments": { "$ref": "#/components/schemas/IIssuerBrandingFromArgs" }, "returnType": { "$ref": "#/components/schemas/IBasicIssuerLocaleBranding" } }, "ibRemoveCredentialBranding": { "description": "", "arguments": { "$ref": "#/components/schemas/IRemoveCredentialBrandingArgs" }, "returnType": { "$ref": "#/components/schemas/IDeletionResult" } }, "ibRemoveCredentialLocaleBranding": { "description": "", "arguments": { "$ref": "#/components/schemas/IRemoveCredentialLocaleBrandingArgs" }, "returnType": { "$ref": "#/components/schemas/IDeletionResult" } }, "ibRemoveIssuerBranding": { "description": "", "arguments": { "$ref": "#/components/schemas/IRemoveIssuerBrandingArgs" }, "returnType": { "$ref": "#/components/schemas/IDeletionResult" } }, "ibRemoveIssuerLocaleBranding": { "description": "", "arguments": { "$ref": "#/components/schemas/IRemoveIssuerLocaleBrandingArgs" }, "returnType": { "$ref": "#/components/schemas/IDeletionResult" } }, "ibUpdateCredentialBranding": { "description": "", "arguments": { "$ref": "#/components/schemas/IUpdateCredentialBrandingArgs" }, "returnType": { "$ref": "#/components/schemas/ICredentialBranding" } }, "ibUpdateCredentialLocaleBranding": { "description": "", "arguments": { "$ref": "#/components/schemas/IUpdateCredentialLocaleBrandingArgs" }, "returnType": { "$ref": "#/components/schemas/ICredentialLocaleBranding" } }, "ibUpdateIssuerBranding": { "description": "", "arguments": { "$ref": "#/components/schemas/IUpdateIssuerBrandingArgs" }, "returnType": { "$ref": "#/components/schemas/IIssuerBranding" } }, "ibUpdateIssuerLocaleBranding": { "description": "", "arguments": { "$ref": "#/components/schemas/IUpdateIssuerLocaleBrandingArgs" }, "returnType": { "$ref": "#/components/schemas/IIssuerLocaleBranding" } } } } } }