apikey.go 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463
  1. // Code generated by ent, DO NOT EDIT.
  2. package ent
  3. import (
  4. "encoding/json"
  5. "fmt"
  6. "strings"
  7. "time"
  8. "entgo.io/ent"
  9. "entgo.io/ent/dialect/sql"
  10. "github.com/Wei-Shaw/sub2api/ent/apikey"
  11. "github.com/Wei-Shaw/sub2api/ent/group"
  12. "github.com/Wei-Shaw/sub2api/ent/user"
  13. )
  14. // APIKey is the model entity for the APIKey schema.
  15. type APIKey struct {
  16. config `json:"-"`
  17. // ID of the ent.
  18. ID int64 `json:"id,omitempty"`
  19. // CreatedAt holds the value of the "created_at" field.
  20. CreatedAt time.Time `json:"created_at,omitempty"`
  21. // UpdatedAt holds the value of the "updated_at" field.
  22. UpdatedAt time.Time `json:"updated_at,omitempty"`
  23. // DeletedAt holds the value of the "deleted_at" field.
  24. DeletedAt *time.Time `json:"deleted_at,omitempty"`
  25. // UserID holds the value of the "user_id" field.
  26. UserID int64 `json:"user_id,omitempty"`
  27. // Key holds the value of the "key" field.
  28. Key string `json:"key,omitempty"`
  29. // KeyHash holds the value of the "key_hash" field.
  30. KeyHash string `json:"-"`
  31. // KeyPrefix holds the value of the "key_prefix" field.
  32. KeyPrefix string `json:"key_prefix,omitempty"`
  33. // Name holds the value of the "name" field.
  34. Name string `json:"name,omitempty"`
  35. // GroupID holds the value of the "group_id" field.
  36. GroupID *int64 `json:"group_id,omitempty"`
  37. // Status holds the value of the "status" field.
  38. Status string `json:"status,omitempty"`
  39. // Last usage time of this API key
  40. LastUsedAt *time.Time `json:"last_used_at,omitempty"`
  41. // Allowed IPs/CIDRs, e.g. ["192.168.1.100", "10.0.0.0/8"]
  42. IPWhitelist []string `json:"ip_whitelist,omitempty"`
  43. // Blocked IPs/CIDRs
  44. IPBlacklist []string `json:"ip_blacklist,omitempty"`
  45. // Quota limit in USD for this API key (0 = unlimited)
  46. Quota float64 `json:"quota,omitempty"`
  47. // Used quota amount in USD
  48. QuotaUsed float64 `json:"quota_used,omitempty"`
  49. // Expiration time for this API key (null = never expires)
  50. ExpiresAt *time.Time `json:"expires_at,omitempty"`
  51. // Rate limit in USD per 5 hours (0 = unlimited)
  52. RateLimit5h float64 `json:"rate_limit_5h,omitempty"`
  53. // Rate limit in USD per day (0 = unlimited)
  54. RateLimit1d float64 `json:"rate_limit_1d,omitempty"`
  55. // Rate limit in USD per 7 days (0 = unlimited)
  56. RateLimit7d float64 `json:"rate_limit_7d,omitempty"`
  57. // Used amount in USD for the current 5h window
  58. Usage5h float64 `json:"usage_5h,omitempty"`
  59. // Used amount in USD for the current 1d window
  60. Usage1d float64 `json:"usage_1d,omitempty"`
  61. // Used amount in USD for the current 7d window
  62. Usage7d float64 `json:"usage_7d,omitempty"`
  63. // Start time of the current 5h rate limit window
  64. Window5hStart *time.Time `json:"window_5h_start,omitempty"`
  65. // Start time of the current 1d rate limit window
  66. Window1dStart *time.Time `json:"window_1d_start,omitempty"`
  67. // Start time of the current 7d rate limit window
  68. Window7dStart *time.Time `json:"window_7d_start,omitempty"`
  69. // Edges holds the relations/edges for other nodes in the graph.
  70. // The values are being populated by the APIKeyQuery when eager-loading is set.
  71. Edges APIKeyEdges `json:"edges"`
  72. selectValues sql.SelectValues
  73. }
  74. // APIKeyEdges holds the relations/edges for other nodes in the graph.
  75. type APIKeyEdges struct {
  76. // User holds the value of the user edge.
  77. User *User `json:"user,omitempty"`
  78. // Group holds the value of the group edge.
  79. Group *Group `json:"group,omitempty"`
  80. // UsageLogs holds the value of the usage_logs edge.
  81. UsageLogs []*UsageLog `json:"usage_logs,omitempty"`
  82. // loadedTypes holds the information for reporting if a
  83. // type was loaded (or requested) in eager-loading or not.
  84. loadedTypes [3]bool
  85. }
  86. // UserOrErr returns the User value or an error if the edge
  87. // was not loaded in eager-loading, or loaded but was not found.
  88. func (e APIKeyEdges) UserOrErr() (*User, error) {
  89. if e.User != nil {
  90. return e.User, nil
  91. } else if e.loadedTypes[0] {
  92. return nil, &NotFoundError{label: user.Label}
  93. }
  94. return nil, &NotLoadedError{edge: "user"}
  95. }
  96. // GroupOrErr returns the Group value or an error if the edge
  97. // was not loaded in eager-loading, or loaded but was not found.
  98. func (e APIKeyEdges) GroupOrErr() (*Group, error) {
  99. if e.Group != nil {
  100. return e.Group, nil
  101. } else if e.loadedTypes[1] {
  102. return nil, &NotFoundError{label: group.Label}
  103. }
  104. return nil, &NotLoadedError{edge: "group"}
  105. }
  106. // UsageLogsOrErr returns the UsageLogs value or an error if the edge
  107. // was not loaded in eager-loading.
  108. func (e APIKeyEdges) UsageLogsOrErr() ([]*UsageLog, error) {
  109. if e.loadedTypes[2] {
  110. return e.UsageLogs, nil
  111. }
  112. return nil, &NotLoadedError{edge: "usage_logs"}
  113. }
  114. // scanValues returns the types for scanning values from sql.Rows.
  115. func (*APIKey) scanValues(columns []string) ([]any, error) {
  116. values := make([]any, len(columns))
  117. for i := range columns {
  118. switch columns[i] {
  119. case apikey.FieldIPWhitelist, apikey.FieldIPBlacklist:
  120. values[i] = new([]byte)
  121. case apikey.FieldQuota, apikey.FieldQuotaUsed, apikey.FieldRateLimit5h, apikey.FieldRateLimit1d, apikey.FieldRateLimit7d, apikey.FieldUsage5h, apikey.FieldUsage1d, apikey.FieldUsage7d:
  122. values[i] = new(sql.NullFloat64)
  123. case apikey.FieldID, apikey.FieldUserID, apikey.FieldGroupID:
  124. values[i] = new(sql.NullInt64)
  125. case apikey.FieldKey, apikey.FieldKeyHash, apikey.FieldKeyPrefix, apikey.FieldName, apikey.FieldStatus:
  126. values[i] = new(sql.NullString)
  127. case apikey.FieldCreatedAt, apikey.FieldUpdatedAt, apikey.FieldDeletedAt, apikey.FieldLastUsedAt, apikey.FieldExpiresAt, apikey.FieldWindow5hStart, apikey.FieldWindow1dStart, apikey.FieldWindow7dStart:
  128. values[i] = new(sql.NullTime)
  129. default:
  130. values[i] = new(sql.UnknownType)
  131. }
  132. }
  133. return values, nil
  134. }
  135. // assignValues assigns the values that were returned from sql.Rows (after scanning)
  136. // to the APIKey fields.
  137. func (_m *APIKey) assignValues(columns []string, values []any) error {
  138. if m, n := len(values), len(columns); m < n {
  139. return fmt.Errorf("mismatch number of scan values: %d != %d", m, n)
  140. }
  141. for i := range columns {
  142. switch columns[i] {
  143. case apikey.FieldID:
  144. value, ok := values[i].(*sql.NullInt64)
  145. if !ok {
  146. return fmt.Errorf("unexpected type %T for field id", value)
  147. }
  148. _m.ID = int64(value.Int64)
  149. case apikey.FieldCreatedAt:
  150. if value, ok := values[i].(*sql.NullTime); !ok {
  151. return fmt.Errorf("unexpected type %T for field created_at", values[i])
  152. } else if value.Valid {
  153. _m.CreatedAt = value.Time
  154. }
  155. case apikey.FieldUpdatedAt:
  156. if value, ok := values[i].(*sql.NullTime); !ok {
  157. return fmt.Errorf("unexpected type %T for field updated_at", values[i])
  158. } else if value.Valid {
  159. _m.UpdatedAt = value.Time
  160. }
  161. case apikey.FieldDeletedAt:
  162. if value, ok := values[i].(*sql.NullTime); !ok {
  163. return fmt.Errorf("unexpected type %T for field deleted_at", values[i])
  164. } else if value.Valid {
  165. _m.DeletedAt = new(time.Time)
  166. *_m.DeletedAt = value.Time
  167. }
  168. case apikey.FieldUserID:
  169. if value, ok := values[i].(*sql.NullInt64); !ok {
  170. return fmt.Errorf("unexpected type %T for field user_id", values[i])
  171. } else if value.Valid {
  172. _m.UserID = value.Int64
  173. }
  174. case apikey.FieldKey:
  175. if value, ok := values[i].(*sql.NullString); !ok {
  176. return fmt.Errorf("unexpected type %T for field key", values[i])
  177. } else if value.Valid {
  178. _m.Key = value.String
  179. }
  180. case apikey.FieldKeyHash:
  181. if value, ok := values[i].(*sql.NullString); !ok {
  182. return fmt.Errorf("unexpected type %T for field key_hash", values[i])
  183. } else if value.Valid {
  184. _m.KeyHash = value.String
  185. }
  186. case apikey.FieldKeyPrefix:
  187. if value, ok := values[i].(*sql.NullString); !ok {
  188. return fmt.Errorf("unexpected type %T for field key_prefix", values[i])
  189. } else if value.Valid {
  190. _m.KeyPrefix = value.String
  191. }
  192. case apikey.FieldName:
  193. if value, ok := values[i].(*sql.NullString); !ok {
  194. return fmt.Errorf("unexpected type %T for field name", values[i])
  195. } else if value.Valid {
  196. _m.Name = value.String
  197. }
  198. case apikey.FieldGroupID:
  199. if value, ok := values[i].(*sql.NullInt64); !ok {
  200. return fmt.Errorf("unexpected type %T for field group_id", values[i])
  201. } else if value.Valid {
  202. _m.GroupID = new(int64)
  203. *_m.GroupID = value.Int64
  204. }
  205. case apikey.FieldStatus:
  206. if value, ok := values[i].(*sql.NullString); !ok {
  207. return fmt.Errorf("unexpected type %T for field status", values[i])
  208. } else if value.Valid {
  209. _m.Status = value.String
  210. }
  211. case apikey.FieldLastUsedAt:
  212. if value, ok := values[i].(*sql.NullTime); !ok {
  213. return fmt.Errorf("unexpected type %T for field last_used_at", values[i])
  214. } else if value.Valid {
  215. _m.LastUsedAt = new(time.Time)
  216. *_m.LastUsedAt = value.Time
  217. }
  218. case apikey.FieldIPWhitelist:
  219. if value, ok := values[i].(*[]byte); !ok {
  220. return fmt.Errorf("unexpected type %T for field ip_whitelist", values[i])
  221. } else if value != nil && len(*value) > 0 {
  222. if err := json.Unmarshal(*value, &_m.IPWhitelist); err != nil {
  223. return fmt.Errorf("unmarshal field ip_whitelist: %w", err)
  224. }
  225. }
  226. case apikey.FieldIPBlacklist:
  227. if value, ok := values[i].(*[]byte); !ok {
  228. return fmt.Errorf("unexpected type %T for field ip_blacklist", values[i])
  229. } else if value != nil && len(*value) > 0 {
  230. if err := json.Unmarshal(*value, &_m.IPBlacklist); err != nil {
  231. return fmt.Errorf("unmarshal field ip_blacklist: %w", err)
  232. }
  233. }
  234. case apikey.FieldQuota:
  235. if value, ok := values[i].(*sql.NullFloat64); !ok {
  236. return fmt.Errorf("unexpected type %T for field quota", values[i])
  237. } else if value.Valid {
  238. _m.Quota = value.Float64
  239. }
  240. case apikey.FieldQuotaUsed:
  241. if value, ok := values[i].(*sql.NullFloat64); !ok {
  242. return fmt.Errorf("unexpected type %T for field quota_used", values[i])
  243. } else if value.Valid {
  244. _m.QuotaUsed = value.Float64
  245. }
  246. case apikey.FieldExpiresAt:
  247. if value, ok := values[i].(*sql.NullTime); !ok {
  248. return fmt.Errorf("unexpected type %T for field expires_at", values[i])
  249. } else if value.Valid {
  250. _m.ExpiresAt = new(time.Time)
  251. *_m.ExpiresAt = value.Time
  252. }
  253. case apikey.FieldRateLimit5h:
  254. if value, ok := values[i].(*sql.NullFloat64); !ok {
  255. return fmt.Errorf("unexpected type %T for field rate_limit_5h", values[i])
  256. } else if value.Valid {
  257. _m.RateLimit5h = value.Float64
  258. }
  259. case apikey.FieldRateLimit1d:
  260. if value, ok := values[i].(*sql.NullFloat64); !ok {
  261. return fmt.Errorf("unexpected type %T for field rate_limit_1d", values[i])
  262. } else if value.Valid {
  263. _m.RateLimit1d = value.Float64
  264. }
  265. case apikey.FieldRateLimit7d:
  266. if value, ok := values[i].(*sql.NullFloat64); !ok {
  267. return fmt.Errorf("unexpected type %T for field rate_limit_7d", values[i])
  268. } else if value.Valid {
  269. _m.RateLimit7d = value.Float64
  270. }
  271. case apikey.FieldUsage5h:
  272. if value, ok := values[i].(*sql.NullFloat64); !ok {
  273. return fmt.Errorf("unexpected type %T for field usage_5h", values[i])
  274. } else if value.Valid {
  275. _m.Usage5h = value.Float64
  276. }
  277. case apikey.FieldUsage1d:
  278. if value, ok := values[i].(*sql.NullFloat64); !ok {
  279. return fmt.Errorf("unexpected type %T for field usage_1d", values[i])
  280. } else if value.Valid {
  281. _m.Usage1d = value.Float64
  282. }
  283. case apikey.FieldUsage7d:
  284. if value, ok := values[i].(*sql.NullFloat64); !ok {
  285. return fmt.Errorf("unexpected type %T for field usage_7d", values[i])
  286. } else if value.Valid {
  287. _m.Usage7d = value.Float64
  288. }
  289. case apikey.FieldWindow5hStart:
  290. if value, ok := values[i].(*sql.NullTime); !ok {
  291. return fmt.Errorf("unexpected type %T for field window_5h_start", values[i])
  292. } else if value.Valid {
  293. _m.Window5hStart = new(time.Time)
  294. *_m.Window5hStart = value.Time
  295. }
  296. case apikey.FieldWindow1dStart:
  297. if value, ok := values[i].(*sql.NullTime); !ok {
  298. return fmt.Errorf("unexpected type %T for field window_1d_start", values[i])
  299. } else if value.Valid {
  300. _m.Window1dStart = new(time.Time)
  301. *_m.Window1dStart = value.Time
  302. }
  303. case apikey.FieldWindow7dStart:
  304. if value, ok := values[i].(*sql.NullTime); !ok {
  305. return fmt.Errorf("unexpected type %T for field window_7d_start", values[i])
  306. } else if value.Valid {
  307. _m.Window7dStart = new(time.Time)
  308. *_m.Window7dStart = value.Time
  309. }
  310. default:
  311. _m.selectValues.Set(columns[i], values[i])
  312. }
  313. }
  314. return nil
  315. }
  316. // Value returns the ent.Value that was dynamically selected and assigned to the APIKey.
  317. // This includes values selected through modifiers, order, etc.
  318. func (_m *APIKey) Value(name string) (ent.Value, error) {
  319. return _m.selectValues.Get(name)
  320. }
  321. // QueryUser queries the "user" edge of the APIKey entity.
  322. func (_m *APIKey) QueryUser() *UserQuery {
  323. return NewAPIKeyClient(_m.config).QueryUser(_m)
  324. }
  325. // QueryGroup queries the "group" edge of the APIKey entity.
  326. func (_m *APIKey) QueryGroup() *GroupQuery {
  327. return NewAPIKeyClient(_m.config).QueryGroup(_m)
  328. }
  329. // QueryUsageLogs queries the "usage_logs" edge of the APIKey entity.
  330. func (_m *APIKey) QueryUsageLogs() *UsageLogQuery {
  331. return NewAPIKeyClient(_m.config).QueryUsageLogs(_m)
  332. }
  333. // Update returns a builder for updating this APIKey.
  334. // Note that you need to call APIKey.Unwrap() before calling this method if this APIKey
  335. // was returned from a transaction, and the transaction was committed or rolled back.
  336. func (_m *APIKey) Update() *APIKeyUpdateOne {
  337. return NewAPIKeyClient(_m.config).UpdateOne(_m)
  338. }
  339. // Unwrap unwraps the APIKey entity that was returned from a transaction after it was closed,
  340. // so that all future queries will be executed through the driver which created the transaction.
  341. func (_m *APIKey) Unwrap() *APIKey {
  342. _tx, ok := _m.config.driver.(*txDriver)
  343. if !ok {
  344. panic("ent: APIKey is not a transactional entity")
  345. }
  346. _m.config.driver = _tx.drv
  347. return _m
  348. }
  349. // String implements the fmt.Stringer.
  350. func (_m *APIKey) String() string {
  351. var builder strings.Builder
  352. builder.WriteString("APIKey(")
  353. builder.WriteString(fmt.Sprintf("id=%v, ", _m.ID))
  354. builder.WriteString("created_at=")
  355. builder.WriteString(_m.CreatedAt.Format(time.ANSIC))
  356. builder.WriteString(", ")
  357. builder.WriteString("updated_at=")
  358. builder.WriteString(_m.UpdatedAt.Format(time.ANSIC))
  359. builder.WriteString(", ")
  360. if v := _m.DeletedAt; v != nil {
  361. builder.WriteString("deleted_at=")
  362. builder.WriteString(v.Format(time.ANSIC))
  363. }
  364. builder.WriteString(", ")
  365. builder.WriteString("user_id=")
  366. builder.WriteString(fmt.Sprintf("%v", _m.UserID))
  367. builder.WriteString(", ")
  368. builder.WriteString("key=")
  369. builder.WriteString(_m.Key)
  370. builder.WriteString(", ")
  371. builder.WriteString("key_hash=<sensitive>")
  372. builder.WriteString(", ")
  373. builder.WriteString("key_prefix=")
  374. builder.WriteString(_m.KeyPrefix)
  375. builder.WriteString(", ")
  376. builder.WriteString("name=")
  377. builder.WriteString(_m.Name)
  378. builder.WriteString(", ")
  379. if v := _m.GroupID; v != nil {
  380. builder.WriteString("group_id=")
  381. builder.WriteString(fmt.Sprintf("%v", *v))
  382. }
  383. builder.WriteString(", ")
  384. builder.WriteString("status=")
  385. builder.WriteString(_m.Status)
  386. builder.WriteString(", ")
  387. if v := _m.LastUsedAt; v != nil {
  388. builder.WriteString("last_used_at=")
  389. builder.WriteString(v.Format(time.ANSIC))
  390. }
  391. builder.WriteString(", ")
  392. builder.WriteString("ip_whitelist=")
  393. builder.WriteString(fmt.Sprintf("%v", _m.IPWhitelist))
  394. builder.WriteString(", ")
  395. builder.WriteString("ip_blacklist=")
  396. builder.WriteString(fmt.Sprintf("%v", _m.IPBlacklist))
  397. builder.WriteString(", ")
  398. builder.WriteString("quota=")
  399. builder.WriteString(fmt.Sprintf("%v", _m.Quota))
  400. builder.WriteString(", ")
  401. builder.WriteString("quota_used=")
  402. builder.WriteString(fmt.Sprintf("%v", _m.QuotaUsed))
  403. builder.WriteString(", ")
  404. if v := _m.ExpiresAt; v != nil {
  405. builder.WriteString("expires_at=")
  406. builder.WriteString(v.Format(time.ANSIC))
  407. }
  408. builder.WriteString(", ")
  409. builder.WriteString("rate_limit_5h=")
  410. builder.WriteString(fmt.Sprintf("%v", _m.RateLimit5h))
  411. builder.WriteString(", ")
  412. builder.WriteString("rate_limit_1d=")
  413. builder.WriteString(fmt.Sprintf("%v", _m.RateLimit1d))
  414. builder.WriteString(", ")
  415. builder.WriteString("rate_limit_7d=")
  416. builder.WriteString(fmt.Sprintf("%v", _m.RateLimit7d))
  417. builder.WriteString(", ")
  418. builder.WriteString("usage_5h=")
  419. builder.WriteString(fmt.Sprintf("%v", _m.Usage5h))
  420. builder.WriteString(", ")
  421. builder.WriteString("usage_1d=")
  422. builder.WriteString(fmt.Sprintf("%v", _m.Usage1d))
  423. builder.WriteString(", ")
  424. builder.WriteString("usage_7d=")
  425. builder.WriteString(fmt.Sprintf("%v", _m.Usage7d))
  426. builder.WriteString(", ")
  427. if v := _m.Window5hStart; v != nil {
  428. builder.WriteString("window_5h_start=")
  429. builder.WriteString(v.Format(time.ANSIC))
  430. }
  431. builder.WriteString(", ")
  432. if v := _m.Window1dStart; v != nil {
  433. builder.WriteString("window_1d_start=")
  434. builder.WriteString(v.Format(time.ANSIC))
  435. }
  436. builder.WriteString(", ")
  437. if v := _m.Window7dStart; v != nil {
  438. builder.WriteString("window_7d_start=")
  439. builder.WriteString(v.Format(time.ANSIC))
  440. }
  441. builder.WriteByte(')')
  442. return builder.String()
  443. }
  444. // APIKeys is a parsable slice of APIKey.
  445. type APIKeys []*APIKey