2.0info: 1.1.1 license_manager description: Serviço Gerenciador de Licenças x-senior-domain: platform x-senior-domain-path: platform x-senior-service-path: license_manager contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/platformsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /license_manager/queries/check: post: description: Verifica as informações de uma licensa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – licenseKey properties: licenseKey: type: string description: Chave da licença responses: 200: description: Ok schema: type: object required: – active – productId – kind – customerName – customerEmail – activationLimit properties: active: type: boolean description: Indica se a licença esta ativa productId: type: string description: identificador do produto kind: type: string allOf: – #/definitions/licenseKind description: Modalidade da Licença customerName: type: string description: Nome do cliente customerEmail: type: string description: Email do cliente activationLimit: type: integer format: int64 description: Limite de Ativação do Produto default: description: Error response schema: #/definitions/genericError get: description: Verifica as informações de uma licensa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: licenseKey in: query required: true type: string responses: 200: description: Ok schema: type: object required: – active – productId – kind – customerName – customerEmail – activationLimit properties: active: type: boolean description: Indica se a licença esta ativa productId: type: string description: identificador do produto kind: type: string allOf: – #/definitions/licenseKind description: Modalidade da Licença customerName: type: string description: Nome do cliente customerEmail: type: string description: Email do cliente activationLimit: type: integer format: int64 description: Limite de Ativação do Produto default: description: Error response schema: #/definitions/genericError /license_manager/queries/getLicenses: post: description: Obtém a lista de licenças por tenant tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: tenant: type: string description: Tenant que possui as licenças, se não for informado é assumido que o tenat é o do usuário logado responses: 200: description: Ok schema: type: object required: – licenses properties: licenses: type: array items: type: object allOf: – #/definitions/license minimum: 1 description: Lista com as licenças encontradas default: description: Error response schema: #/definitions/genericError get: description: Obtém a lista de licenças por tenant tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tenant in: query type: string responses: 200: description: Ok schema: type: object required: – licenses properties: licenses: type: array items: type: object allOf: – #/definitions/license minimum: 1 description: Lista com as licenças encontradas default: description: Error response schema: #/definitions/genericError /license_manager/queries/getCustomerSuccessInfo: post: description: Obtém informações a respeito do customer success tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – email properties: email: type: string description: Email do customer success default: description: Error response schema: #/definitions/genericError get: description: Obtém informações a respeito do customer success tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – email properties: email: type: string description: Email do customer success default: description: Error response schema: #/definitions/genericError /license_manager/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError /license_manager/queries/exportLicense: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /license_manager/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError /license_manager/actions/generate: post: description: Gera um nova licensa sem validar tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – productId – kind – tenant – username – customerName – customerEmail properties: productId: type: string description: identificador do produto kind: type: string allOf: – #/definitions/licenseKind description: Tipo da Licensa tenant: type: string description: Tenant username: type: string description: Usuário que ativou a licença customerName: type: string description: Nome do Cliente customerEmail: type: string description: E-mail do Cliente responses: 200: description: Ok schema: type: object required: – licenseKey properties: licenseKey: type: string description: Chave da licença default: description: Error response schema: #/definitions/genericError /license_manager/actions/activate: post: description: Habilita Licensa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – licenseKey properties: licenseKey: type: string description: Chave da licença responses: 200: description: Ok schema: type: object allOf: – #/definitions/result default: description: Error response schema: #/definitions/genericError /license_manager/actions/downgrade: post: description: Faz o downgrade de uma licença gerando uma nova tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – licenseKey properties: licenseKey: type: string description: Chave da licença para o downgrade responses: 200: description: Ok schema: type: object required: – licenseKey properties: licenseKey: type: string description: Chave da nova licença default: description: Error response schema: #/definitions/genericError /license_manager/actions/upgrade: post: description: Faz o upgrade de uma licença para uma com mais recursos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – licenseKey properties: licenseKey: type: string description: Chave da licença original responses: 200: description: Ok schema: type: object required: – licenseKey properties: licenseKey: type: string description: Chave da nova licença default: description: Error response schema: #/definitions/genericError /license_manager/actions/desactivate: post: description: Deabilita Licensa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – licenseKey properties: licenseKey: type: string description: Chave da licença responses: 200: description: Ok schema: type: object allOf: – #/definitions/result default: description: Error response schema: #/definitions/genericError /license_manager/actions/importLicense: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /license_manager/entities/license: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/license responses: 200: description: The created resource schema: #/definitions/license default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/license responses: 200: description: The created resource schema: #/definitions/license default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/license default: description: Error response schema: #/definitions/genericError /license_manager/entities/license/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/license responses: 200: description: Ok schema: #/definitions/license default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/license responses: 200: description: Ok schema: #/definitions/license default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/license default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /license_manager/entities/license/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/license responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError definitions: licenseKind: description: Tipo da Licença type: string enum: – Trial – Basic – Premium userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR result: description: Retorno Genrico de um serviço type: object required: – ok properties: ok: type: boolean description: Indica retorno com sucesso license: description: Representa uma licença type: object required: – licenseKey – productId – kind – customerName – customerEmail – activationLimit – username – tenant – created – updated – active properties: licenseKey: type: string description: Chave da licença productId: type: string description: identificador do produto kind: type: string allOf: – #/definitions/licenseKind description: tipo de licença customerName: type: string description: Nome do cliente customerEmail: type: string description: Email do cliente activationLimit: type: integer format: int64 description: Limite de Ativação do Produto username: type: string description: Usuário que ativou a licença tenant: type: string description: Tenant created: type: string format: date-time description: Data de criação updated: type: string format: date-time description: Data da última modficação active: type: boolean description: Indica se a licença esta ativa notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE