feat!: change language type to be more strict in magic link options

src/classes/Auth/types.ts

@@ -1,19 +1,18 @@
-import { MagicLinkChannel, MagicLinkType } from '../../generated';
+import { MagicLinkChannel, MagicLinkLanguage, MagicLinkType } from '../../generated';
 
-export { MagicLinkType, MagicLink, MagicLinkChannel } from '../../generated';
+export { MagicLinkType, MagicLink, MagicLinkChannel, MagicLinkLanguage } from '../../generated';
 
 type MagicLinkArgsBase = {
     type: MagicLinkType;
     send: boolean;
 };
 
-type MagicLinkWithEmailArgs = { email: string } & MagicLinkArgsBase;
-type MagicLinkWithPhoneArgs = { phone: string } & MagicLinkArgsBase;
-type MagicLinkWithUserArgs = { userId: string; channel: MagicLinkChannel } & MagicLinkArgsBase;
-
+export type MagicLinkWithEmailArgs = { email: string } & MagicLinkArgsBase;
+export type MagicLinkWithPhoneArgs = { phone: string } & MagicLinkArgsBase;
+export type MagicLinkWithUserArgs = { userId: string; channel: MagicLinkChannel } & MagicLinkArgsBase;
 export type CreateMagicLinkArgs = MagicLinkWithEmailArgs | MagicLinkWithPhoneArgs | MagicLinkWithUserArgs;
 export type MagicLinkOptions = {
-    language?: string;
+    language?: MagicLinkLanguage;
     magicLinkPath?: string;
     redirectUrl?: string;
     ttl?: number;

src/generated/.openapi-generator/FILES

@@ -16,6 +16,7 @@ models/ListPaginatedUsersItem.ts
 models/ListPaginatedUsersResponse.ts
 models/MagicLink.ts
 models/MagicLinkChannel.ts
+models/MagicLinkLanguage.ts
 models/MagicLinkResponse.ts
 models/MagicLinkType.ts
 models/Model400Error.ts

src/generated/models/CreateMagicLinkRequest.ts

@@ -20,6 +20,13 @@ import {
     MagicLinkChannelToJSON,
     MagicLinkChannelToJSONTyped,
 } from './MagicLinkChannel';
+import type { MagicLinkLanguage } from './MagicLinkLanguage';
+import {
+    MagicLinkLanguageFromJSON,
+    MagicLinkLanguageFromJSONTyped,
+    MagicLinkLanguageToJSON,
+    MagicLinkLanguageToJSONTyped,
+} from './MagicLinkLanguage';
 import type { MagicLinkType } from './MagicLinkType';
 import {
     MagicLinkTypeFromJSON,
@@ -47,11 +54,11 @@ export interface CreateMagicLinkRequest {
      */
     email?: string;
     /**
-     * language of the email to send (optional)
-     * @type {string}
+     * 
+     * @type {MagicLinkLanguage}
      * @memberof CreateMagicLinkRequest
      */
-    language?: string;
+    language?: MagicLinkLanguage;
     /**
      * must be a relative url
      * @type {string}
@@ -77,7 +84,7 @@ export interface CreateMagicLinkRequest {
      */
     send?: boolean;
     /**
-     * 
+     * time to live in minutes
      * @type {number}
      * @memberof CreateMagicLinkRequest
      */
@@ -117,7 +124,7 @@ export function CreateMagicLinkRequestFromJSONTyped(json: any, ignoreDiscriminat
 
         'channel': json['channel'] == null ? undefined : MagicLinkChannelFromJSON(json['channel']),
         'email': json['email'] == null ? undefined : json['email'],
-        'language': json['language'] == null ? undefined : json['language'],
+        'language': json['language'] == null ? undefined : MagicLinkLanguageFromJSON(json['language']),
         'magicLinkPath': json['magic_link_path'] == null ? undefined : json['magic_link_path'],
         'phone': json['phone'] == null ? undefined : json['phone'],
         'redirectUrl': json['redirect_url'] == null ? undefined : json['redirect_url'],
@@ -141,7 +148,7 @@ export function CreateMagicLinkRequestToJSONTyped(value?: CreateMagicLinkRequest
 
         'channel': MagicLinkChannelToJSON(value['channel']),
         'email': value['email'],
-        'language': value['language'],
+        'language': MagicLinkLanguageToJSON(value['language']),
         'magic_link_path': value['magicLinkPath'],
         'phone': value['phone'],
         'redirect_url': value['redirectUrl'],

src/generated/models/MagicLink.ts

@@ -64,7 +64,7 @@ export interface MagicLink {
      */
     secret: string;
     /**
-     * 
+     * time to live in minutes
      * @type {number}
      * @memberof MagicLink
      */

src/generated/models/MagicLinkChannel.ts

@@ -14,7 +14,7 @@
 
 
 /**
- * 
+ * The channel for magic link delivery: "email" or "phone". Required if "send" is true.
  * @export
  */
 export const MagicLinkChannel = {

src/generated/models/MagicLinkLanguage.ts

@@ -0,0 +1,58 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Passage Management API
+ * Passage\'s management API to manage your Passage apps and users.
+ *
+ * The version of the OpenAPI document: 1
+ * Contact: [email protected]
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * language of the email or sms to send
+ * @export
+ */
+export const MagicLinkLanguage = {
+    De: 'de',
+    En: 'en',
+    Es: 'es',
+    It: 'it',
+    Pl: 'pl',
+    Pt: 'pt',
+    Zh: 'zh'
+} as const;
+export type MagicLinkLanguage = typeof MagicLinkLanguage[keyof typeof MagicLinkLanguage];
+
+
+export function instanceOfMagicLinkLanguage(value: any): boolean {
+    for (const key in MagicLinkLanguage) {
+        if (Object.prototype.hasOwnProperty.call(MagicLinkLanguage, key)) {
+            if (MagicLinkLanguage[key as keyof typeof MagicLinkLanguage] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function MagicLinkLanguageFromJSON(json: any): MagicLinkLanguage {
+    return MagicLinkLanguageFromJSONTyped(json, false);
+}
+
+export function MagicLinkLanguageFromJSONTyped(json: any, ignoreDiscriminator: boolean): MagicLinkLanguage {
+    return json as MagicLinkLanguage;
+}
+
+export function MagicLinkLanguageToJSON(value?: MagicLinkLanguage | null): any {
+    return value as any;
+}
+
+export function MagicLinkLanguageToJSONTyped(value: any, ignoreDiscriminator: boolean): MagicLinkLanguage {
+    return value as MagicLinkLanguage;
+}
+

src/generated/models/MagicLinkType.ts

@@ -14,7 +14,7 @@
 
 
 /**
- * 
+ * The type of magic link to create: "login" or "verify_identifier". Defaults to "login".
  * @export
  */
 export const MagicLinkType = {

src/generated/models/index.ts

@@ -11,6 +11,7 @@ export * from './ListPaginatedUsersItem';
 export * from './ListPaginatedUsersResponse';
 export * from './MagicLink';
 export * from './MagicLinkChannel';
+export * from './MagicLinkLanguage';
 export * from './MagicLinkResponse';
 export * from './MagicLinkType';
 export * from './Model400Error';