Activation key http reference

getActivationKeys

/activationKeys

Response Dto/Entity: *[]licenses.ActivationKeyEntity

message ActivationKeyEntity {
  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 series = 6; // @tag(  yaml:"series")
  bool used = 7; // @tag(  yaml:"used")
  /* One 2 one to external entity */
  optional string planId  = 9; // @tag(yaml:"planId")
  ProductPlanEntity plan = 10; // @tag(gorm:"foreignKey:PlanId;references:UniqueId" json:"plan" yaml:"plan")

}

export interface ActivationKeyEntity {
    /** @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:"series") */
    series: string;
    /** @tag(  yaml:"used") */
    used: boolean;
    /** One 2 one to external entity */
    planId?: string | undefined;
    /** @tag(gorm:"foreignKey:PlanId;references:UniqueId" json:"plan" yaml:"plan") */
    plan: ProductPlanEntity | undefined;
}

getActivationKeyById

/activationKey/:id

Response Dto/Entity: *licenses.ActivationKeyEntity

message ActivationKeyEntity {
  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 series = 6; // @tag(  yaml:"series")
  bool used = 7; // @tag(  yaml:"used")
  /* One 2 one to external entity */
  optional string planId  = 9; // @tag(yaml:"planId")
  ProductPlanEntity plan = 10; // @tag(gorm:"foreignKey:PlanId;references:UniqueId" json:"plan" yaml:"plan")

}

export interface ActivationKeyEntity {
    /** @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:"series") */
    series: string;
    /** @tag(  yaml:"used") */
    used: boolean;
    /** One 2 one to external entity */
    planId?: string | undefined;
    /** @tag(gorm:"foreignKey:PlanId;references:UniqueId" json:"plan" yaml:"plan") */
    plan: ProductPlanEntity | undefined;
}

Params: :id

postActivationKey

/activationKey

Response Dto/Entity: *licenses.ActivationKeyEntity

message ActivationKeyEntity {
  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 series = 6; // @tag(  yaml:"series")
  bool used = 7; // @tag(  yaml:"used")
  /* One 2 one to external entity */
  optional string planId  = 9; // @tag(yaml:"planId")
  ProductPlanEntity plan = 10; // @tag(gorm:"foreignKey:PlanId;references:UniqueId" json:"plan" yaml:"plan")

}

export interface ActivationKeyEntity {
    /** @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:"series") */
    series: string;
    /** @tag(  yaml:"used") */
    used: boolean;
    /** One 2 one to external entity */
    planId?: string | undefined;
    /** @tag(gorm:"foreignKey:PlanId;references:UniqueId" json:"plan" yaml:"plan") */
    plan: ProductPlanEntity | undefined;
}

Request Dto/Entity: *licenses.ActivationKeyEntity

message ActivationKeyEntity {
  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 series = 6; // @tag(  yaml:"series")
  bool used = 7; // @tag(  yaml:"used")
  /* One 2 one to external entity */
  optional string planId  = 9; // @tag(yaml:"planId")
  ProductPlanEntity plan = 10; // @tag(gorm:"foreignKey:PlanId;references:UniqueId" json:"plan" yaml:"plan")

}

export interface ActivationKeyEntity {
    /** @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:"series") */
    series: string;
    /** @tag(  yaml:"used") */
    used: boolean;
    /** One 2 one to external entity */
    planId?: string | undefined;
    /** @tag(gorm:"foreignKey:PlanId;references:UniqueId" json:"plan" yaml:"plan") */
    plan: ProductPlanEntity | undefined;
}

patchActivationKeyById

/activationKey/:id

Response Dto/Entity: *licenses.ActivationKeyEntity

message ActivationKeyEntity {
  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 series = 6; // @tag(  yaml:"series")
  bool used = 7; // @tag(  yaml:"used")
  /* One 2 one to external entity */
  optional string planId  = 9; // @tag(yaml:"planId")
  ProductPlanEntity plan = 10; // @tag(gorm:"foreignKey:PlanId;references:UniqueId" json:"plan" yaml:"plan")

}

export interface ActivationKeyEntity {
    /** @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:"series") */
    series: string;
    /** @tag(  yaml:"used") */
    used: boolean;
    /** One 2 one to external entity */
    planId?: string | undefined;
    /** @tag(gorm:"foreignKey:PlanId;references:UniqueId" json:"plan" yaml:"plan") */
    plan: ProductPlanEntity | undefined;
}

Request Dto/Entity: *licenses.ActivationKeyEntity

message ActivationKeyEntity {
  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 series = 6; // @tag(  yaml:"series")
  bool used = 7; // @tag(  yaml:"used")
  /* One 2 one to external entity */
  optional string planId  = 9; // @tag(yaml:"planId")
  ProductPlanEntity plan = 10; // @tag(gorm:"foreignKey:PlanId;references:UniqueId" json:"plan" yaml:"plan")

}

export interface ActivationKeyEntity {
    /** @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:"series") */
    series: string;
    /** @tag(  yaml:"used") */
    used: boolean;
    /** One 2 one to external entity */
    planId?: string | undefined;
    /** @tag(gorm:"foreignKey:PlanId;references:UniqueId" json:"plan" yaml:"plan") */
    plan: ProductPlanEntity | undefined;
}

Params: :id

deleteActivationKeyById

/activationKey/:id

Target Entity: *licenses.ActivationKeyEntity

message ActivationKeyEntity {
  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 series = 6; // @tag(  yaml:"series")
  bool used = 7; // @tag(  yaml:"used")
  /* One 2 one to external entity */
  optional string planId  = 9; // @tag(yaml:"planId")
  ProductPlanEntity plan = 10; // @tag(gorm:"foreignKey:PlanId;references:UniqueId" json:"plan" yaml:"plan")

}

export interface ActivationKeyEntity {
    /** @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:"series") */
    series: string;
    /** @tag(  yaml:"used") */
    used: boolean;
    /** One 2 one to external entity */
    planId?: string | undefined;
    /** @tag(gorm:"foreignKey:PlanId;references:UniqueId" json:"plan" yaml:"plan") */
    plan: ProductPlanEntity | undefined;
}

Params: :id