Email provider 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.

Browse content
Fireback ‐ Ultimate Go FullStack Framework

getEmailProviders

emailProviders

Response Dto/Entity: *[]workspaces.EmailProviderEntity

message EmailProviderEntity {
  optional string workspaceId = 1; // @tag(yaml:"workspaceId")
  optional string parentId = 2; // @tag(yaml:"parentId")
  string uniqueId = 3; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  optional string userId = 4; // @tag(yaml:"userId")
  optional string type = 6; // @tag( validate:"required" yaml:"type" )
  optional string apiKey = 7; // @tag( validate:"required" yaml:"apiKey" )
  optional string visibility = 8; // @tag(yaml:"visibility")

}

export interface EmailProviderEntity {
  /** @tag(yaml:"workspaceId") */
  workspaceId?: string | undefined;
  /** @tag(yaml:"parentId") */
  parentId?: string | undefined;
  /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
  uniqueId: string;
  /** @tag(yaml:"userId") */
  userId?: string | undefined;
  /** @tag( validate:"required" yaml:"type" ) */
  type?: string | undefined;
  /** @tag( validate:"required" yaml:"apiKey" ) */
  apiKey?: string | undefined;
  /** @tag(yaml:"visibility") */
  visibility?: string | undefined;
}

getEmailProviderByUniqueId

emailProvider/:uniqueId

Response Dto/Entity: *workspaces.EmailProviderEntity

message EmailProviderEntity {
  optional string workspaceId = 1; // @tag(yaml:"workspaceId")
  optional string parentId = 2; // @tag(yaml:"parentId")
  string uniqueId = 3; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  optional string userId = 4; // @tag(yaml:"userId")
  optional string type = 6; // @tag( validate:"required" yaml:"type" )
  optional string apiKey = 7; // @tag( validate:"required" yaml:"apiKey" )
  optional string visibility = 8; // @tag(yaml:"visibility")

}

export interface EmailProviderEntity {
  /** @tag(yaml:"workspaceId") */
  workspaceId?: string | undefined;
  /** @tag(yaml:"parentId") */
  parentId?: string | undefined;
  /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
  uniqueId: string;
  /** @tag(yaml:"userId") */
  userId?: string | undefined;
  /** @tag( validate:"required" yaml:"type" ) */
  type?: string | undefined;
  /** @tag( validate:"required" yaml:"apiKey" ) */
  apiKey?: string | undefined;
  /** @tag(yaml:"visibility") */
  visibility?: string | undefined;
}

Params: :uniqueId

postEmailProvider

emailProvider

Response Dto/Entity: *workspaces.EmailProviderEntity

message EmailProviderEntity {
  optional string workspaceId = 1; // @tag(yaml:"workspaceId")
  optional string parentId = 2; // @tag(yaml:"parentId")
  string uniqueId = 3; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  optional string userId = 4; // @tag(yaml:"userId")
  optional string type = 6; // @tag( validate:"required" yaml:"type" )
  optional string apiKey = 7; // @tag( validate:"required" yaml:"apiKey" )
  optional string visibility = 8; // @tag(yaml:"visibility")

}

export interface EmailProviderEntity {
  /** @tag(yaml:"workspaceId") */
  workspaceId?: string | undefined;
  /** @tag(yaml:"parentId") */
  parentId?: string | undefined;
  /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
  uniqueId: string;
  /** @tag(yaml:"userId") */
  userId?: string | undefined;
  /** @tag( validate:"required" yaml:"type" ) */
  type?: string | undefined;
  /** @tag( validate:"required" yaml:"apiKey" ) */
  apiKey?: string | undefined;
  /** @tag(yaml:"visibility") */
  visibility?: string | undefined;
}

Request Dto/Entity: *workspaces.EmailProviderEntity

message EmailProviderEntity {
  optional string workspaceId = 1; // @tag(yaml:"workspaceId")
  optional string parentId = 2; // @tag(yaml:"parentId")
  string uniqueId = 3; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  optional string userId = 4; // @tag(yaml:"userId")
  optional string type = 6; // @tag( validate:"required" yaml:"type" )
  optional string apiKey = 7; // @tag( validate:"required" yaml:"apiKey" )
  optional string visibility = 8; // @tag(yaml:"visibility")

}

export interface EmailProviderEntity {
  /** @tag(yaml:"workspaceId") */
  workspaceId?: string | undefined;
  /** @tag(yaml:"parentId") */
  parentId?: string | undefined;
  /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
  uniqueId: string;
  /** @tag(yaml:"userId") */
  userId?: string | undefined;
  /** @tag( validate:"required" yaml:"type" ) */
  type?: string | undefined;
  /** @tag( validate:"required" yaml:"apiKey" ) */
  apiKey?: string | undefined;
  /** @tag(yaml:"visibility") */
  visibility?: string | undefined;
}

patchEmailProvider

emailProvider

Response Dto/Entity: *workspaces.EmailProviderEntity

message EmailProviderEntity {
  optional string workspaceId = 1; // @tag(yaml:"workspaceId")
  optional string parentId = 2; // @tag(yaml:"parentId")
  string uniqueId = 3; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  optional string userId = 4; // @tag(yaml:"userId")
  optional string type = 6; // @tag( validate:"required" yaml:"type" )
  optional string apiKey = 7; // @tag( validate:"required" yaml:"apiKey" )
  optional string visibility = 8; // @tag(yaml:"visibility")

}

export interface EmailProviderEntity {
  /** @tag(yaml:"workspaceId") */
  workspaceId?: string | undefined;
  /** @tag(yaml:"parentId") */
  parentId?: string | undefined;
  /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
  uniqueId: string;
  /** @tag(yaml:"userId") */
  userId?: string | undefined;
  /** @tag( validate:"required" yaml:"type" ) */
  type?: string | undefined;
  /** @tag( validate:"required" yaml:"apiKey" ) */
  apiKey?: string | undefined;
  /** @tag(yaml:"visibility") */
  visibility?: string | undefined;
}

Request Dto/Entity: *workspaces.EmailProviderEntity

message EmailProviderEntity {
  optional string workspaceId = 1; // @tag(yaml:"workspaceId")
  optional string parentId = 2; // @tag(yaml:"parentId")
  string uniqueId = 3; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  optional string userId = 4; // @tag(yaml:"userId")
  optional string type = 6; // @tag( validate:"required" yaml:"type" )
  optional string apiKey = 7; // @tag( validate:"required" yaml:"apiKey" )
  optional string visibility = 8; // @tag(yaml:"visibility")

}

export interface EmailProviderEntity {
  /** @tag(yaml:"workspaceId") */
  workspaceId?: string | undefined;
  /** @tag(yaml:"parentId") */
  parentId?: string | undefined;
  /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
  uniqueId: string;
  /** @tag(yaml:"userId") */
  userId?: string | undefined;
  /** @tag( validate:"required" yaml:"type" ) */
  type?: string | undefined;
  /** @tag( validate:"required" yaml:"apiKey" ) */
  apiKey?: string | undefined;
  /** @tag(yaml:"visibility") */
  visibility?: string | undefined;
}

patchEmailProviders

emailProviders

Response Dto/Entity: *core.BulkRecordRequest[workspaces.EmailProviderEntity]

Request Dto/Entity: *core.BulkRecordRequest[workspaces.EmailProviderEntity]

deleteEmailProvider

emailProvider

Request Dto/Entity: *core.DeleteRequest

Target Entity: *workspaces.EmailProviderEntity

message EmailProviderEntity {
  optional string workspaceId = 1; // @tag(yaml:"workspaceId")
  optional string parentId = 2; // @tag(yaml:"parentId")
  string uniqueId = 3; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  optional string userId = 4; // @tag(yaml:"userId")
  optional string type = 6; // @tag( validate:"required" yaml:"type" )
  optional string apiKey = 7; // @tag( validate:"required" yaml:"apiKey" )
  optional string visibility = 8; // @tag(yaml:"visibility")

}

export interface EmailProviderEntity {
  /** @tag(yaml:"workspaceId") */
  workspaceId?: string | undefined;
  /** @tag(yaml:"parentId") */
  parentId?: string | undefined;
  /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
  uniqueId: string;
  /** @tag(yaml:"userId") */
  userId?: string | undefined;
  /** @tag( validate:"required" yaml:"type" ) */
  type?: string | undefined;
  /** @tag( validate:"required" yaml:"apiKey" ) */
  apiKey?: string | undefined;
  /** @tag(yaml:"visibility") */
  visibility?: string | undefined;
}

Ali Torabi

Software Engineer

Ali Torabi's github account
My name is Ali Torabi, I am a software engineer who is highly interested in JavaScript, Golang and C++. I serve clients, build projects and create content and videos. Started programming in primary school, still at age of 31 it's main activity I do.