License http reference

Fireback accelerates backend and mobile app development, offering powerful code generation tools and standardized architecture. With seamless backend integration and streamlined workflows, Fireback expedites the creation of robust and scalable apps.

getLicenses

/licenses

Response Dto/Entity: *[]licenses.LicenseEntity

message LicenseEntity {
  string workspaceId = 1; // @tag(yaml:"workspaceId")
  string parentId = 2; // @tag(yaml:"parentId")
  string uniqueId = 3; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  string userId = 4; // @tag(yaml:"userId")
  string name = 6; // @tag(  yaml:"name")
  string signedLicense = 7; // @tag(  yaml:"signedLicense")
  google.protobuf.Timestamp validityStartDate = 8; // @tag( yaml:"validityStartDate")
  google.protobuf.Timestamp validityEndDate = 9; // @tag( yaml:"validityEndDate")
  /* This is an object, another entity needs to be created for */
  repeated LicenseFeatureEntity features = 10; // @tag(gorm:"foreignKey:ParentId;references:UniqueId" yaml:"features")

}
export interface LicenseEntity {
    /** @tag(yaml:"workspaceId") */
    workspaceId: string;
    /** @tag(yaml:"parentId") */
    parentId: string;
    /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
    uniqueId: string;
    /** @tag(yaml:"userId") */
    userId: string;
    /** @tag(  yaml:"name") */
    name: string;
    /** @tag(  yaml:"signedLicense") */
    signedLicense: string;
    /** @tag( yaml:"validityStartDate") */
    validityStartDate: Date | undefined;
    /** @tag( yaml:"validityEndDate") */
    validityEndDate: Date | undefined;
    /** This is an object, another entity needs to be created for */
    features: LicenseFeatureEntity[];
}

getLicenseById

/license/:id

Response Dto/Entity: *licenses.LicenseEntity

message LicenseEntity {
  string workspaceId = 1; // @tag(yaml:"workspaceId")
  string parentId = 2; // @tag(yaml:"parentId")
  string uniqueId = 3; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  string userId = 4; // @tag(yaml:"userId")
  string name = 6; // @tag(  yaml:"name")
  string signedLicense = 7; // @tag(  yaml:"signedLicense")
  google.protobuf.Timestamp validityStartDate = 8; // @tag( yaml:"validityStartDate")
  google.protobuf.Timestamp validityEndDate = 9; // @tag( yaml:"validityEndDate")
  /* This is an object, another entity needs to be created for */
  repeated LicenseFeatureEntity features = 10; // @tag(gorm:"foreignKey:ParentId;references:UniqueId" yaml:"features")

}
export interface LicenseEntity {
    /** @tag(yaml:"workspaceId") */
    workspaceId: string;
    /** @tag(yaml:"parentId") */
    parentId: string;
    /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
    uniqueId: string;
    /** @tag(yaml:"userId") */
    userId: string;
    /** @tag(  yaml:"name") */
    name: string;
    /** @tag(  yaml:"signedLicense") */
    signedLicense: string;
    /** @tag( yaml:"validityStartDate") */
    validityStartDate: Date | undefined;
    /** @tag( yaml:"validityEndDate") */
    validityEndDate: Date | undefined;
    /** This is an object, another entity needs to be created for */
    features: LicenseFeatureEntity[];
}

Params: :id

postLicense

/license

Response Dto/Entity: *licenses.LicenseEntity

message LicenseEntity {
  string workspaceId = 1; // @tag(yaml:"workspaceId")
  string parentId = 2; // @tag(yaml:"parentId")
  string uniqueId = 3; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  string userId = 4; // @tag(yaml:"userId")
  string name = 6; // @tag(  yaml:"name")
  string signedLicense = 7; // @tag(  yaml:"signedLicense")
  google.protobuf.Timestamp validityStartDate = 8; // @tag( yaml:"validityStartDate")
  google.protobuf.Timestamp validityEndDate = 9; // @tag( yaml:"validityEndDate")
  /* This is an object, another entity needs to be created for */
  repeated LicenseFeatureEntity features = 10; // @tag(gorm:"foreignKey:ParentId;references:UniqueId" yaml:"features")

}
export interface LicenseEntity {
    /** @tag(yaml:"workspaceId") */
    workspaceId: string;
    /** @tag(yaml:"parentId") */
    parentId: string;
    /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
    uniqueId: string;
    /** @tag(yaml:"userId") */
    userId: string;
    /** @tag(  yaml:"name") */
    name: string;
    /** @tag(  yaml:"signedLicense") */
    signedLicense: string;
    /** @tag( yaml:"validityStartDate") */
    validityStartDate: Date | undefined;
    /** @tag( yaml:"validityEndDate") */
    validityEndDate: Date | undefined;
    /** This is an object, another entity needs to be created for */
    features: LicenseFeatureEntity[];
}

Request Dto/Entity: *licenses.LicenseEntity

message LicenseEntity {
  string workspaceId = 1; // @tag(yaml:"workspaceId")
  string parentId = 2; // @tag(yaml:"parentId")
  string uniqueId = 3; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  string userId = 4; // @tag(yaml:"userId")
  string name = 6; // @tag(  yaml:"name")
  string signedLicense = 7; // @tag(  yaml:"signedLicense")
  google.protobuf.Timestamp validityStartDate = 8; // @tag( yaml:"validityStartDate")
  google.protobuf.Timestamp validityEndDate = 9; // @tag( yaml:"validityEndDate")
  /* This is an object, another entity needs to be created for */
  repeated LicenseFeatureEntity features = 10; // @tag(gorm:"foreignKey:ParentId;references:UniqueId" yaml:"features")

}
export interface LicenseEntity {
    /** @tag(yaml:"workspaceId") */
    workspaceId: string;
    /** @tag(yaml:"parentId") */
    parentId: string;
    /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
    uniqueId: string;
    /** @tag(yaml:"userId") */
    userId: string;
    /** @tag(  yaml:"name") */
    name: string;
    /** @tag(  yaml:"signedLicense") */
    signedLicense: string;
    /** @tag( yaml:"validityStartDate") */
    validityStartDate: Date | undefined;
    /** @tag( yaml:"validityEndDate") */
    validityEndDate: Date | undefined;
    /** This is an object, another entity needs to be created for */
    features: LicenseFeatureEntity[];
}

patchLicenseById

/license/:id

Response Dto/Entity: *licenses.LicenseEntity

message LicenseEntity {
  string workspaceId = 1; // @tag(yaml:"workspaceId")
  string parentId = 2; // @tag(yaml:"parentId")
  string uniqueId = 3; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  string userId = 4; // @tag(yaml:"userId")
  string name = 6; // @tag(  yaml:"name")
  string signedLicense = 7; // @tag(  yaml:"signedLicense")
  google.protobuf.Timestamp validityStartDate = 8; // @tag( yaml:"validityStartDate")
  google.protobuf.Timestamp validityEndDate = 9; // @tag( yaml:"validityEndDate")
  /* This is an object, another entity needs to be created for */
  repeated LicenseFeatureEntity features = 10; // @tag(gorm:"foreignKey:ParentId;references:UniqueId" yaml:"features")

}
export interface LicenseEntity {
    /** @tag(yaml:"workspaceId") */
    workspaceId: string;
    /** @tag(yaml:"parentId") */
    parentId: string;
    /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
    uniqueId: string;
    /** @tag(yaml:"userId") */
    userId: string;
    /** @tag(  yaml:"name") */
    name: string;
    /** @tag(  yaml:"signedLicense") */
    signedLicense: string;
    /** @tag( yaml:"validityStartDate") */
    validityStartDate: Date | undefined;
    /** @tag( yaml:"validityEndDate") */
    validityEndDate: Date | undefined;
    /** This is an object, another entity needs to be created for */
    features: LicenseFeatureEntity[];
}

Request Dto/Entity: *licenses.LicenseEntity

message LicenseEntity {
  string workspaceId = 1; // @tag(yaml:"workspaceId")
  string parentId = 2; // @tag(yaml:"parentId")
  string uniqueId = 3; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  string userId = 4; // @tag(yaml:"userId")
  string name = 6; // @tag(  yaml:"name")
  string signedLicense = 7; // @tag(  yaml:"signedLicense")
  google.protobuf.Timestamp validityStartDate = 8; // @tag( yaml:"validityStartDate")
  google.protobuf.Timestamp validityEndDate = 9; // @tag( yaml:"validityEndDate")
  /* This is an object, another entity needs to be created for */
  repeated LicenseFeatureEntity features = 10; // @tag(gorm:"foreignKey:ParentId;references:UniqueId" yaml:"features")

}
export interface LicenseEntity {
    /** @tag(yaml:"workspaceId") */
    workspaceId: string;
    /** @tag(yaml:"parentId") */
    parentId: string;
    /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
    uniqueId: string;
    /** @tag(yaml:"userId") */
    userId: string;
    /** @tag(  yaml:"name") */
    name: string;
    /** @tag(  yaml:"signedLicense") */
    signedLicense: string;
    /** @tag( yaml:"validityStartDate") */
    validityStartDate: Date | undefined;
    /** @tag( yaml:"validityEndDate") */
    validityEndDate: Date | undefined;
    /** This is an object, another entity needs to be created for */
    features: LicenseFeatureEntity[];
}

Params: :id

deleteLicenseById

/license/:id

Target Entity: *licenses.LicenseEntity

message LicenseEntity {
  string workspaceId = 1; // @tag(yaml:"workspaceId")
  string parentId = 2; // @tag(yaml:"parentId")
  string uniqueId = 3; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  string userId = 4; // @tag(yaml:"userId")
  string name = 6; // @tag(  yaml:"name")
  string signedLicense = 7; // @tag(  yaml:"signedLicense")
  google.protobuf.Timestamp validityStartDate = 8; // @tag( yaml:"validityStartDate")
  google.protobuf.Timestamp validityEndDate = 9; // @tag( yaml:"validityEndDate")
  /* This is an object, another entity needs to be created for */
  repeated LicenseFeatureEntity features = 10; // @tag(gorm:"foreignKey:ParentId;references:UniqueId" yaml:"features")

}
export interface LicenseEntity {
    /** @tag(yaml:"workspaceId") */
    workspaceId: string;
    /** @tag(yaml:"parentId") */
    parentId: string;
    /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
    uniqueId: string;
    /** @tag(yaml:"userId") */
    userId: string;
    /** @tag(  yaml:"name") */
    name: string;
    /** @tag(  yaml:"signedLicense") */
    signedLicense: string;
    /** @tag( yaml:"validityStartDate") */
    validityStartDate: Date | undefined;
    /** @tag( yaml:"validityEndDate") */
    validityEndDate: Date | undefined;
    /** This is an object, another entity needs to be created for */
    features: LicenseFeatureEntity[];
}

Params: :id

postLicenseFromPlanById

/license/from-plan/:id

Response Dto/Entity: *licenses.LicenseEntity

message LicenseEntity {
  string workspaceId = 1; // @tag(yaml:"workspaceId")
  string parentId = 2; // @tag(yaml:"parentId")
  string uniqueId = 3; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  string userId = 4; // @tag(yaml:"userId")
  string name = 6; // @tag(  yaml:"name")
  string signedLicense = 7; // @tag(  yaml:"signedLicense")
  google.protobuf.Timestamp validityStartDate = 8; // @tag( yaml:"validityStartDate")
  google.protobuf.Timestamp validityEndDate = 9; // @tag( yaml:"validityEndDate")
  /* This is an object, another entity needs to be created for */
  repeated LicenseFeatureEntity features = 10; // @tag(gorm:"foreignKey:ParentId;references:UniqueId" yaml:"features")

}
export interface LicenseEntity {
    /** @tag(yaml:"workspaceId") */
    workspaceId: string;
    /** @tag(yaml:"parentId") */
    parentId: string;
    /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
    uniqueId: string;
    /** @tag(yaml:"userId") */
    userId: string;
    /** @tag(  yaml:"name") */
    name: string;
    /** @tag(  yaml:"signedLicense") */
    signedLicense: string;
    /** @tag( yaml:"validityStartDate") */
    validityStartDate: Date | undefined;
    /** @tag( yaml:"validityEndDate") */
    validityEndDate: Date | undefined;
    /** This is an object, another entity needs to be created for */
    features: LicenseFeatureEntity[];
}

Request Dto/Entity: *licenses.LicenseFromPlanIdDto

message LicenseFromPlanIdDto {
    string machineId = 1;
    string email = 2;
    string owner = 3;
}
export interface LicenseFromPlanIdDto {
    machineId: string;
    email: string;
    owner: string;
}

Params: :id