Plugin Sources

Create a new plugin source

POST

http://localhost:3000/api/plugins/{pluginId}/versions/{versionId}/sources

curl -X POST 'http://localhost:3000/api/plugins/550e8400-e29b-41d4-a716-446655440000/versions/550e8400-e29b-41d4-a716-446655440000/sources' \
  --form-string 'sources={"name":"source1","operatingSystem":"UNIVERSAL","architecture":"X64","url":"https://example.com/plugin1","type":"CDN"}'

const form = new FormData();
form.append('sources', '{"name":"source1","operatingSystem":"UNIVERSAL","architecture":"X64","url":"https://example.com/plugin1","type":"CDN"}');
const response = await fetch('http://localhost:3000/api/plugins/550e8400-e29b-41d4-a716-446655440000/versions/550e8400-e29b-41d4-a716-446655440000/sources', {
  method: 'POST',
  headers: {},
  body: form,
});
console.log(await response.text());

import requests
from contextlib import ExitStack

with ExitStack() as stack:
    files = [
        ('sources', (None, '{"name":"source1","operatingSystem":"UNIVERSAL","architecture":"X64","url":"https://example.com/plugin1","type":"CDN"}')),
    ]
    response = requests.request('POST', 'http://localhost:3000/api/plugins/550e8400-e29b-41d4-a716-446655440000/versions/550e8400-e29b-41d4-a716-446655440000/sources', headers={}, files=files)
    print(response.text)

Request Body

{
  "sources": {
    "name": "source1",
    "operatingSystem": "UNIVERSAL",
    "architecture": "X64",
    "url": "https://example.com/plugin1",
    "type": "CDN"
  }
}

201

[
  {
    "isActive": true,
    "isArchived": false,
    "archivedAt": "2018-11-21T06:20:32.232Z",
    "tenantId": "string",
    "organizationId": "string",
    "type": "CDN",
    "operatingSystem": "LINUX",
    "architecture": "X64",
    "url": "string",
    "integrity": "string",
    "crossOrigin": "string",
    "name": "string",
    "registry": "string",
    "private": false,
    "scope": "string",
    "filePath": "string",
    "fileName": "string",
    "fileSize": 0,
    "mimeType": "string",
    "fileKey": "string",
    "version": {
      "deletedAt": "2018-11-21T06:20:32.232Z",
      "createdAt": "2018-11-21T06:20:32.232Z",
      "updatedAt": "2018-11-21T06:20:32.232Z",
      "id": "string",
      "isActive": true,
      "isArchived": false,
      "archivedAt": "2018-11-21T06:20:32.232Z",
      "tenantId": "string",
      "organizationId": "string",
      "number": "string",
      "changelog": "string",
      "checksum": "string",
      "signature": "string",
      "releaseDate": "string",
      "downloadCount": 0,
      "plugin": {
        "deletedAt": "2018-11-21T06:20:32.232Z",
        "createdAt": "2018-11-21T06:20:32.232Z",
        "updatedAt": "2018-11-21T06:20:32.232Z",
        "id": "string",
        "isActive": false,
        "isArchived": false,
        "archivedAt": "2018-11-21T06:20:32.232Z",
        "name": "string",
        "description": "string",
        "type": "DESKTOP",
        "status": "ACTIVE",
        "categoryId": "string",
        "category": {},
        "versions": [
          "string"
        ],
        "author": "string",
        "license": "string",
        "homepage": "string",
        "repository": "string",
        "uploadedBy": {
          "deletedAt": "2018-11-21T06:20:32.232Z",
          "createdAt": "2018-11-21T06:20:32.232Z",
          "updatedAt": "2018-11-21T06:20:32.232Z",
          "id": "string",
          "isActive": true,
          "isArchived": false,
          "archivedAt": "2018-11-21T06:20:32.232Z",
          "tenantId": "string",
          "thirdPartyId": "string",
          "firstName": "string",
          "lastName": "string",
          "email": "string",
          "phoneNumber": "string",
          "username": "string",
          "timeZone": "string",
          "timeFormat": 12,
          "hash": "string",
          "refreshToken": "string",
          "imageUrl": "string",
          "preferredLanguage": "en",
          "preferredComponentLayout": "CARDS_GRID",
          "uiPreferences": {},
          "code": "string",
          "codeExpireAt": "2024-01-15T09:30:00Z",
          "emailVerifiedAt": "2024-01-15T09:30:00Z",
          "lastLoginAt": "2024-01-15T09:30:00Z",
          "emailToken": "string",
          "roleId": "string",
          "imageId": "string",
          "defaultTeamId": "string",
          "lastTeamId": "string",
          "defaultOrganizationId": "string",
          "lastOrganizationId": "string"
        },
        "uploadedAt": "2024-01-15T09:30:00Z",
        "requiresSubscription": false,
        "isFeatured": false,
        "isVerified": false,
        "lastDownloadedAt": "2024-01-15T09:30:00Z",
        "pluginTenants": [
          "string"
        ],
        "settings": [
          "string"
        ],
        "subscriptions": [
          "string"
        ],
        "subscriptionPlans": [
          "string"
        ],
        "pluginTags": [
          "string"
        ]
      },
      "sources": [
        {
          "deletedAt": "2018-11-21T06:20:32.232Z",
          "createdAt": "2018-11-21T06:20:32.232Z",
          "updatedAt": "2018-11-21T06:20:32.232Z",
          "id": "string",
          "isActive": true,
          "isArchived": false,
          "archivedAt": "2018-11-21T06:20:32.232Z",
          "tenantId": "string",
          "organizationId": "string",
          "type": "CDN",
          "operatingSystem": "LINUX",
          "architecture": "X64",
          "url": "string",
          "integrity": "string",
          "crossOrigin": "string",
          "name": "string",
          "registry": "string",
          "private": false,
          "scope": "string",
          "filePath": "string",
          "fileName": "string",
          "fileSize": 0,
          "mimeType": "string",
          "fileKey": "string",
          "storageProvider": "LOCAL"
        }
      ],
      "installations": [
        {
          "deletedAt": "2018-11-21T06:20:32.232Z",
          "createdAt": "2018-11-21T06:20:32.232Z",
          "updatedAt": "2018-11-21T06:20:32.232Z",
          "id": "string",
          "isActive": true,
          "isArchived": false,
          "archivedAt": "2018-11-21T06:20:32.232Z",
          "tenantId": "string",
          "organizationId": "string",
          "plugin": {
            "deletedAt": "2018-11-21T06:20:32.232Z",
            "createdAt": "2018-11-21T06:20:32.232Z",
            "updatedAt": "2018-11-21T06:20:32.232Z",
            "id": "string",
            "isActive": false,
            "isArchived": false,
            "archivedAt": "2018-11-21T06:20:32.232Z",
            "name": "string",
            "description": "string",
            "type": "DESKTOP",
            "status": "ACTIVE",
            "categoryId": "string",
            "category": {},
            "versions": [
              "string"
            ],
            "author": "string",
            "license": "string",
            "homepage": "string",
            "repository": "string",
            "uploadedBy": {
              "deletedAt": "2018-11-21T06:20:32.232Z",
              "createdAt": "2018-11-21T06:20:32.232Z",
              "updatedAt": "2018-11-21T06:20:32.232Z",
              "id": "string",
              "isActive": true,
              "isArchived": false,
              "archivedAt": "2018-11-21T06:20:32.232Z",
              "tenantId": "string",
              "thirdPartyId": "string",
              "firstName": "string",
              "lastName": "string",
              "email": "string",
              "phoneNumber": "string",
              "username": "string",
              "timeZone": "string",
              "timeFormat": 12,
              "hash": "string",
              "refreshToken": "string",
              "imageUrl": "string",
              "preferredLanguage": "en",
              "preferredComponentLayout": "CARDS_GRID",
              "uiPreferences": {},
              "code": "string",
              "codeExpireAt": "2024-01-15T09:30:00Z",
              "emailVerifiedAt": "2024-01-15T09:30:00Z",
              "lastLoginAt": "2024-01-15T09:30:00Z",
              "emailToken": "string",
              "roleId": "string",
              "imageId": "string",
              "defaultTeamId": "string",
              "lastTeamId": "string",
              "defaultOrganizationId": "string",
              "lastOrganizationId": "string"
            },
            "uploadedAt": "2024-01-15T09:30:00Z",
            "requiresSubscription": false,
            "isFeatured": false,
            "isVerified": false,
            "lastDownloadedAt": "2024-01-15T09:30:00Z",
            "pluginTenants": [
              "string"
            ],
            "settings": [
              "string"
            ],
            "subscriptions": [
              "string"
            ],
            "subscriptionPlans": [
              "string"
            ],
            "pluginTags": [
              "string"
            ]
          },
          "installedBy": {
            "deletedAt": "2018-11-21T06:20:32.232Z",
            "createdAt": "2018-11-21T06:20:32.232Z",
            "updatedAt": "2018-11-21T06:20:32.232Z",
            "id": "string",
            "isActive": true,
            "isArchived": false,
            "archivedAt": "2018-11-21T06:20:32.232Z",
            "tenantId": "string",
            "organizationId": "string",
            "short_description": "string",
            "description": "string",
            "startedWorkOn": "2024-01-15T09:30:00Z",
            "endWork": "2024-01-15T09:30:00Z",
            "payPeriod": "WEEKLY",
            "billRateValue": 0,
            "minimumBillingRate": 0,
            "billRateCurrency": "USD",
            "reWeeklyLimit": 0,
            "offerDate": "2024-01-15T09:30:00Z",
            "acceptDate": "2024-01-15T09:30:00Z",
            "rejectDate": "2024-01-15T09:30:00Z",
            "employeeLevel": "string",
            "anonymousBonus": true,
            "averageIncome": 0,
            "averageBonus": 0,
            "totalWorkHours": 0,
            "averageExpenses": 0,
            "show_anonymous_bonus": true,
            "show_average_bonus": true,
            "show_average_expenses": true,
            "show_average_income": true,
            "show_billrate": true,
            "show_payperiod": true,
            "show_start_work_on": true,
            "isJobSearchActive": true,
            "linkedInUrl": "string",
            "facebookUrl": "string",
            "instagramUrl": "string",
            "twitterUrl": "string",
            "githubUrl": "string",
            "gitlabUrl": "string",
            "upworkUrl": "string",
            "stackoverflowUrl": "string",
            "isVerified": true,
            "isVetted": true,
            "totalJobs": 0,
            "jobSuccess": 0,
            "profile_link": "string",
            "isTrackingEnabled": true,
            "isOnline": true,
            "isAway": false,
            "isTrackingTime": true,
            "allowScreenshotCapture": true,
            "allowManualTime": true,
            "allowModifyTime": true,
            "allowDeleteTime": true,
            "allowAgentAppExit": true,
            "allowLogoutFromAgentApp": true,
            "trackKeyboardMouseActivity": true,
            "trackAllDisplays": true,
            "upworkId": "string",
            "linkedInId": "string",
            "userId": "string",
            "contactId": "string",
            "organizationPositionId": "string"
          },
          "installedAt": "string",
          "uninstalledAt": "string",
          "status": "INSTALLED",
          "isActivated": false,
          "activatedAt": "2024-01-15T09:30:00Z",
          "deactivatedAt": "2024-01-15T09:30:00Z"
        }
      ]
    },
    "storageProvider": "LOCAL"
  }
]

Body

multipart/form-data

The data required to create a new plugin source.

sourcesArray<PluginSourceDTO>required

Array of plugin sources

Show child attributes

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

typestringCDNNPMGAUZYrequired

Type of the plugin source

operatingSystemstringLINUXMACWINDOWSUNIVERSALrequired

Plugin Os type source

architecturestringX64ARMrequired

Plugin Os type source architecture

urlstringrequired

URL of the plugin source (CDN)

integritystringrequired

Integrity hash for the CDN source

crossOriginstringrequired

Cross-origin policy for the CDN source

namestringrequired

NPM package name

registrystringrequired

NPM registry URL

privatebooleanfalse

Indicates if the package is private (requires NPM authentication token for access).

scopestringrequired

NPM scope (if applicable)

filePathstringrequired

File path for uploaded plugin

fileNamestringrequired

File name of the uploaded plugin

fileSizenumberrequired

File size of the uploaded plugin (in bytes)

mimeTypestringrequired

MIME type of the uploaded plugin file

fileKeystringrequired

Plugin file identifier

versionPluginVersion_1required

Associated plugin version

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

numberstringrequired

Version following SemVer (MAJOR.MINOR.PATCH[-prerelease][+build])

changelogstringrequired

Change Log of the plugin version

checksumstringrequired

Verification hash of the plugin version

signaturestringrequired

Digital signature for authenticity verification

releaseDatestring

Date when the release was recorded

downloadCountnumberrequired

Download count

pluginPlugin_1required

Plugin associated with the version

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleanfalse

Plugin is active or not

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

namestringrequired

Plugin name

descriptionstring

Plugin description

typestringDESKTOPWEBMOBILErequired

Type of the plugin

statusstringACTIVEINACTIVEDEPRECATEDARCHIVEDrequired

Status of the plugin

categoryIdstring

Plugin category ID

categoryobject

Plugin category

versionsArray<string>required

Versions of the plugin

authorstring

Plugin author

licensestring

Plugin license

homepagestring

Homepage URL

repositorystring

Repository URL

uploadedByUser

User who uploaded the plugin

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

thirdPartyIdstring

firstNamestring

lastNamestring

emailstring

phoneNumberstring

usernamestring

timeZonestring

timeFormatstring1224

hashstring

refreshTokenstring

imageUrlstring

preferredLanguagestringenbgherufreszhdeptitnlplar

preferredComponentLayoutstringCARDS_GRIDTABLE

uiPreferencesobject

codestring

codeExpireAtstring<date-time>

emailVerifiedAtstring<date-time>

lastLoginAtstring<date-time>

emailTokenstring

roleIdstring

imageIdstring

defaultTeamIdstring

lastTeamIdstring

defaultOrganizationIdstring

lastOrganizationIdstring

uploadedAtstring<date-time>

Upload date

requiresSubscriptionbooleanfalserequired

Is subscription plan enabled

isFeaturedbooleanfalserequired

Whether the plugin is featured

isVerifiedbooleanfalserequired

Whether the plugin is verified by Gauzy

lastDownloadedAtstring<date-time>

Last downloaded date

pluginTenantsArray<string>

Plugin tenants for this plugin

settingsArray<string>

Plugin settings

subscriptionsArray<string>

Plugin subscriptions

subscriptionPlansArray<string>

Plugin subscription plans

pluginTagsArray<string>

Plugin tag relationships

sourcesArray<PluginSource_1>

Sources of the plugin version

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

typestringCDNNPMGAUZYrequired

Type of the plugin source

operatingSystemstringLINUXMACWINDOWSUNIVERSALrequired

Plugin Os type source

architecturestringX64ARMrequired

Plugin Os type source architecture

urlstringrequired

URL of the plugin source (CDN)

integritystringrequired

Integrity hash for the CDN source

crossOriginstringrequired

Cross-origin policy for the CDN source

namestringrequired

NPM package name

registrystringrequired

NPM registry URL

privatebooleanfalse

Indicates if the package is private (requires NPM authentication token for access).

scopestringrequired

NPM scope (if applicable)

filePathstringrequired

File path for uploaded plugin

fileNamestringrequired

File name of the uploaded plugin

fileSizenumberrequired

File size of the uploaded plugin (in bytes)

mimeTypestringrequired

MIME type of the uploaded plugin file

fileKeystringrequired

Plugin file identifier

versionPluginVersion_1required

Associated plugin version

Show child attributes

PluginVersion_1

storageProviderstringLOCALS3WASABICLOUDINARYDIGITALOCEAN

installationsArray<PluginInstallation_1>

Related installations to plugin version

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

pluginPlugin_1required

Installed the plugin

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleanfalse

Plugin is active or not

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

namestringrequired

Plugin name

descriptionstring

Plugin description

typestringDESKTOPWEBMOBILErequired

Type of the plugin

statusstringACTIVEINACTIVEDEPRECATEDARCHIVEDrequired

Status of the plugin

categoryIdstring

Plugin category ID

categoryobject

Plugin category

versionsArray<string>required

Versions of the plugin

authorstring

Plugin author

licensestring

Plugin license

homepagestring

Homepage URL

repositorystring

Repository URL

uploadedByUser

User who uploaded the plugin

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

thirdPartyIdstring

firstNamestring

lastNamestring

emailstring

phoneNumberstring

usernamestring

timeZonestring

timeFormatstring1224

hashstring

refreshTokenstring

imageUrlstring

preferredLanguagestringenbgherufreszhdeptitnlplar

preferredComponentLayoutstringCARDS_GRIDTABLE

uiPreferencesobject

codestring

codeExpireAtstring<date-time>

emailVerifiedAtstring<date-time>

lastLoginAtstring<date-time>

emailTokenstring

roleIdstring

imageIdstring

defaultTeamIdstring

lastTeamIdstring

defaultOrganizationIdstring

lastOrganizationIdstring

uploadedAtstring<date-time>

Upload date

requiresSubscriptionbooleanfalserequired

Is subscription plan enabled

isFeaturedbooleanfalserequired

Whether the plugin is featured

isVerifiedbooleanfalserequired

Whether the plugin is verified by Gauzy

lastDownloadedAtstring<date-time>

Last downloaded date

pluginTenantsArray<string>

Plugin tenants for this plugin

settingsArray<string>

Plugin settings

subscriptionsArray<string>

Plugin subscriptions

subscriptionPlansArray<string>

Plugin subscription plans

pluginTagsArray<string>

Plugin tag relationships

versionPluginVersion_1required

Installed version of the plugin

Show child attributes

PluginVersion_1

installedByEmployee

Employee who installed the plugin

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

short_descriptionstring

descriptionstring

startedWorkOnstring<date-time>

endWorkstring<date-time>

payPeriodstringNONEBI_WEEKLYWEEKLYTWICE_PER_MONTHMONTHLY

Example

WEEKLY

billRateValuenumber

minimumBillingRatenumber

billRateCurrencystringAFNAFAALLALKDZDADPAOAAOKAONAORARAARSARMARPARLAMDAWGAUDATSAZNAZMBSDBHDBDTBBDBYNBYBBYRBEFBECBELBZDBMDBTNBOBBOLBOVBOPBAMBADBANBWPBRCBRZBREBRRBRNBRBBRLGBPBNDBGLBGNBGOBGMBUKBIFXPFKHRCADCVEKYDXAFCLECLPCLFCNXCNYCOPCOUKMFCDFCRCHRDHRKCUCCUPCYPCZKCSKDKKDJFDOPNLGXCDDDMECSECVEGPGQEERNEEKETBEURXEUFKPFJDFIMFRFXFOXFUGMDGEKGELDEMGHSGHCGIPGRDGTQGWPGNFGNSGYDHTGHNLHKDHUFISKISJINRIDRIRRIQDIEPILSILPILRITLJMDJPYJODKZTKESKWDKGSLAKLVLLVRLBPLSLLRDLYDLTLLTTLULLUCLUFMOPMKDMKNMGAMGFMWKMYRMVRMVPMLFMTLMTPMROMURMXVMXNMXPMDCMDLMCFMNTMADMAFMZEMZNMZMMMKNADNPRANGTWDNZDNIONICNGNKPWNOKOMRPKRPABPGKPYGPEIPENPESPHPPLNPLZPTEGWEQARXRERHDRONROLRUBRURRWFSVCWSTSARRSDCSDSCRSLLSGDSKKSITSBDSOSZARZALKRHKRWKROSSPSURESPESAESBLKRSHPSDDSDGSDPSRDSRGSZLSEKCHFSYPSTDTJRTJSTZSTHBTPETOPTTDTNDTRYTRLTMTTMMUSDUSNUSSUGXUGSUAHUAKAEDUYUUYPUYIUZSVUVVEFVEBVNDVNNCHECHWXOFYDDYERYUNYUDYUMYURZRNZRZZMWZMKZWDZWRZWL

Example

USD

reWeeklyLimitnumber

offerDatestring<date-time>

acceptDatestring<date-time>

rejectDatestring<date-time>

employeeLevelstring

anonymousBonusboolean

averageIncomenumberrequired

averageBonusnumberrequired

totalWorkHoursnumberrequired

averageExpensesnumberrequired

show_anonymous_bonusboolean

show_average_bonusboolean

show_average_expensesboolean

show_average_incomeboolean

show_billrateboolean

show_payperiodboolean

show_start_work_onboolean

isJobSearchActiveboolean

linkedInUrlstring

facebookUrlstring

instagramUrlstring

twitterUrlstring

githubUrlstring

gitlabUrlstring

upworkUrlstring

stackoverflowUrlstring

isVerifiedboolean

isVettedboolean

totalJobsnumberrequired

jobSuccessnumberrequired

profile_linkstring

isTrackingEnabledboolean

isOnlineboolean

isAwaystringfalse

isTrackingTimeboolean

allowScreenshotCaptureboolean

allowManualTimeboolean

allowModifyTimeboolean

allowDeleteTimeboolean

allowAgentAppExitboolean

allowLogoutFromAgentAppboolean

trackKeyboardMouseActivityboolean

trackAllDisplaysboolean

upworkIdstring

linkedInIdstring

userIdstringrequired

contactIdstringrequired

organizationPositionIdstringrequired

installedAtstring

Installed date

uninstalledAtstring

Uninstalled date

statusstringINSTALLEDUNINSTALLEDFAILEDIN_PROGRESSrequired

Plugin installation status

isActivatedbooleanfalse

Whether this installation is currently activated

activatedAtstring<date-time>

When this installation was last activated

deactivatedAtstring<date-time>

When this installation was last deactivated

storageProviderstringLOCALS3WASABICLOUDINARYDIGITALOCEAN

Parameters

pluginIdstring<uuid>requiredpath

The UUID of the plugin for which a new version is being associated to.

versionIdstring<uuid>requiredpath

The UUID of the version for which a new source is being created.

Response

201CreatedArray<PluginSourceDTO>

Plugin source successfully created.

Response fields application/json

Array<PluginSourceDTO>

Show child attributes

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

typestringCDNNPMGAUZYrequired

Type of the plugin source

operatingSystemstringLINUXMACWINDOWSUNIVERSALrequired

Plugin Os type source

architecturestringX64ARMrequired

Plugin Os type source architecture

urlstringrequired

URL of the plugin source (CDN)

integritystringrequired

Integrity hash for the CDN source

crossOriginstringrequired

Cross-origin policy for the CDN source

namestringrequired

NPM package name

registrystringrequired

NPM registry URL

privatebooleanfalse

Indicates if the package is private (requires NPM authentication token for access).

scopestringrequired

NPM scope (if applicable)

filePathstringrequired

File path for uploaded plugin

fileNamestringrequired

File name of the uploaded plugin

fileSizenumberrequired

File size of the uploaded plugin (in bytes)

mimeTypestringrequired

MIME type of the uploaded plugin file

fileKeystringrequired

Plugin file identifier

versionPluginVersion_1required

Associated plugin version

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

numberstringrequired

Version following SemVer (MAJOR.MINOR.PATCH[-prerelease][+build])

changelogstringrequired

Change Log of the plugin version

checksumstringrequired

Verification hash of the plugin version

signaturestringrequired

Digital signature for authenticity verification

releaseDatestring

Date when the release was recorded

downloadCountnumberrequired

Download count

pluginPlugin_1required

Plugin associated with the version

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleanfalse

Plugin is active or not

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

namestringrequired

Plugin name

descriptionstring

Plugin description

typestringDESKTOPWEBMOBILErequired

Type of the plugin

statusstringACTIVEINACTIVEDEPRECATEDARCHIVEDrequired

Status of the plugin

categoryIdstring

Plugin category ID

categoryobject

Plugin category

versionsArray<string>required

Versions of the plugin

authorstring

Plugin author

licensestring

Plugin license

homepagestring

Homepage URL

repositorystring

Repository URL

uploadedByUser

User who uploaded the plugin

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

thirdPartyIdstring

firstNamestring

lastNamestring

emailstring

phoneNumberstring

usernamestring

timeZonestring

timeFormatstring1224

hashstring

refreshTokenstring

imageUrlstring

preferredLanguagestringenbgherufreszhdeptitnlplar

preferredComponentLayoutstringCARDS_GRIDTABLE

uiPreferencesobject

codestring

codeExpireAtstring<date-time>

emailVerifiedAtstring<date-time>

lastLoginAtstring<date-time>

emailTokenstring

roleIdstring

imageIdstring

defaultTeamIdstring

lastTeamIdstring

defaultOrganizationIdstring

lastOrganizationIdstring

uploadedAtstring<date-time>

Upload date

requiresSubscriptionbooleanfalserequired

Is subscription plan enabled

isFeaturedbooleanfalserequired

Whether the plugin is featured

isVerifiedbooleanfalserequired

Whether the plugin is verified by Gauzy

lastDownloadedAtstring<date-time>

Last downloaded date

pluginTenantsArray<string>

Plugin tenants for this plugin

settingsArray<string>

Plugin settings

subscriptionsArray<string>

Plugin subscriptions

subscriptionPlansArray<string>

Plugin subscription plans

pluginTagsArray<string>

Plugin tag relationships

sourcesArray<PluginSource_1>

Sources of the plugin version

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

typestringCDNNPMGAUZYrequired

Type of the plugin source

operatingSystemstringLINUXMACWINDOWSUNIVERSALrequired

Plugin Os type source

architecturestringX64ARMrequired

Plugin Os type source architecture

urlstringrequired

URL of the plugin source (CDN)

integritystringrequired

Integrity hash for the CDN source

crossOriginstringrequired

Cross-origin policy for the CDN source

namestringrequired

NPM package name

registrystringrequired

NPM registry URL

privatebooleanfalse

Indicates if the package is private (requires NPM authentication token for access).

scopestringrequired

NPM scope (if applicable)

filePathstringrequired

File path for uploaded plugin

fileNamestringrequired

File name of the uploaded plugin

fileSizenumberrequired

File size of the uploaded plugin (in bytes)

mimeTypestringrequired

MIME type of the uploaded plugin file

fileKeystringrequired

Plugin file identifier

versionPluginVersion_1required

Associated plugin version

Show child attributes

PluginVersion_1

storageProviderstringLOCALS3WASABICLOUDINARYDIGITALOCEAN

installationsArray<PluginInstallation_1>

Related installations to plugin version

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

pluginPlugin_1required

Installed the plugin

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleanfalse

Plugin is active or not

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

namestringrequired

Plugin name

descriptionstring

Plugin description

typestringDESKTOPWEBMOBILErequired

Type of the plugin

statusstringACTIVEINACTIVEDEPRECATEDARCHIVEDrequired

Status of the plugin

categoryIdstring

Plugin category ID

categoryobject

Plugin category

versionsArray<string>required

Versions of the plugin

authorstring

Plugin author

licensestring

Plugin license

homepagestring

Homepage URL

repositorystring

Repository URL

uploadedByUser

User who uploaded the plugin

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

thirdPartyIdstring

firstNamestring

lastNamestring

emailstring

phoneNumberstring

usernamestring

timeZonestring

timeFormatstring1224

hashstring

refreshTokenstring

imageUrlstring

preferredLanguagestringenbgherufreszhdeptitnlplar

preferredComponentLayoutstringCARDS_GRIDTABLE

uiPreferencesobject

codestring

codeExpireAtstring<date-time>

emailVerifiedAtstring<date-time>

lastLoginAtstring<date-time>

emailTokenstring

roleIdstring

imageIdstring

defaultTeamIdstring

lastTeamIdstring

defaultOrganizationIdstring

lastOrganizationIdstring

uploadedAtstring<date-time>

Upload date

requiresSubscriptionbooleanfalserequired

Is subscription plan enabled

isFeaturedbooleanfalserequired

Whether the plugin is featured

isVerifiedbooleanfalserequired

Whether the plugin is verified by Gauzy

lastDownloadedAtstring<date-time>

Last downloaded date

pluginTenantsArray<string>

Plugin tenants for this plugin

settingsArray<string>

Plugin settings

subscriptionsArray<string>

Plugin subscriptions

subscriptionPlansArray<string>

Plugin subscription plans

pluginTagsArray<string>

Plugin tag relationships

versionPluginVersion_1required

Installed version of the plugin

Show child attributes

PluginVersion_1

installedByEmployee

Employee who installed the plugin

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

short_descriptionstring

descriptionstring

startedWorkOnstring<date-time>

endWorkstring<date-time>

payPeriodstringNONEBI_WEEKLYWEEKLYTWICE_PER_MONTHMONTHLY

Example

WEEKLY

billRateValuenumber

minimumBillingRatenumber

Example

USD

reWeeklyLimitnumber

offerDatestring<date-time>

acceptDatestring<date-time>

rejectDatestring<date-time>

employeeLevelstring

anonymousBonusboolean

averageIncomenumberrequired

averageBonusnumberrequired

totalWorkHoursnumberrequired

averageExpensesnumberrequired

show_anonymous_bonusboolean

show_average_bonusboolean

show_average_expensesboolean

show_average_incomeboolean

show_billrateboolean

show_payperiodboolean

show_start_work_onboolean

isJobSearchActiveboolean

linkedInUrlstring

facebookUrlstring

instagramUrlstring

twitterUrlstring

githubUrlstring

gitlabUrlstring

upworkUrlstring

stackoverflowUrlstring

isVerifiedboolean

isVettedboolean

totalJobsnumberrequired

jobSuccessnumberrequired

profile_linkstring

isTrackingEnabledboolean

isOnlineboolean

isAwaystringfalse

isTrackingTimeboolean

allowScreenshotCaptureboolean

allowManualTimeboolean

allowModifyTimeboolean

allowDeleteTimeboolean

allowAgentAppExitboolean

allowLogoutFromAgentAppboolean

trackKeyboardMouseActivityboolean

trackAllDisplaysboolean

upworkIdstring

linkedInIdstring

userIdstringrequired

contactIdstringrequired

organizationPositionIdstringrequired

installedAtstring

Installed date

uninstalledAtstring

Uninstalled date

statusstringINSTALLEDUNINSTALLEDFAILEDIN_PROGRESSrequired

Plugin installation status

isActivatedbooleanfalse

Whether this installation is currently activated

activatedAtstring<date-time>

When this installation was last activated

deactivatedAtstring<date-time>

When this installation was last deactivated

storageProviderstringLOCALS3WASABICLOUDINARYDIGITALOCEAN

400Bad Request

Bad request - Validation failed.

404Not Found

Version not found.

Stack Overflow Website Demo