@wix/identity 1.0.49 → 1.0.51

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (55) hide show
  1. package/build/cjs/src/iam-authentication-v1-authentication.http.d.ts +18 -3
  2. package/build/cjs/src/iam-authentication-v1-authentication.http.js +34 -13
  3. package/build/cjs/src/iam-authentication-v1-authentication.http.js.map +1 -1
  4. package/build/cjs/src/iam-authentication-v1-authentication.public.d.ts +3 -3
  5. package/build/cjs/src/iam-authentication-v1-authentication.public.js +4 -4
  6. package/build/cjs/src/iam-authentication-v1-authentication.public.js.map +1 -1
  7. package/build/cjs/src/iam-authentication-v1-authentication.types.d.ts +91 -21
  8. package/build/cjs/src/iam-authentication-v1-authentication.types.js.map +1 -1
  9. package/build/cjs/src/iam-authentication-v1-authentication.universal.d.ts +118 -34
  10. package/build/cjs/src/iam-authentication-v1-authentication.universal.js +26 -13
  11. package/build/cjs/src/iam-authentication-v1-authentication.universal.js.map +1 -1
  12. package/build/cjs/src/iam-recovery-v1-recovery.http.d.ts +4 -1
  13. package/build/cjs/src/iam-recovery-v1-recovery.http.js +4 -1
  14. package/build/cjs/src/iam-recovery-v1-recovery.http.js.map +1 -1
  15. package/build/cjs/src/iam-recovery-v1-recovery.types.d.ts +76 -15
  16. package/build/cjs/src/iam-recovery-v1-recovery.types.js.map +1 -1
  17. package/build/cjs/src/iam-recovery-v1-recovery.universal.d.ts +81 -19
  18. package/build/cjs/src/iam-recovery-v1-recovery.universal.js +3 -2
  19. package/build/cjs/src/iam-recovery-v1-recovery.universal.js.map +1 -1
  20. package/build/cjs/src/iam-verification-v1-start-response.http.d.ts +7 -3
  21. package/build/cjs/src/iam-verification-v1-start-response.http.js +7 -3
  22. package/build/cjs/src/iam-verification-v1-start-response.http.js.map +1 -1
  23. package/build/cjs/src/iam-verification-v1-start-response.types.d.ts +73 -12
  24. package/build/cjs/src/iam-verification-v1-start-response.types.js.map +1 -1
  25. package/build/cjs/src/iam-verification-v1-start-response.universal.d.ts +82 -17
  26. package/build/cjs/src/iam-verification-v1-start-response.universal.js +8 -4
  27. package/build/cjs/src/iam-verification-v1-start-response.universal.js.map +1 -1
  28. package/build/es/src/iam-authentication-v1-authentication.http.d.ts +18 -3
  29. package/build/es/src/iam-authentication-v1-authentication.http.js +32 -11
  30. package/build/es/src/iam-authentication-v1-authentication.http.js.map +1 -1
  31. package/build/es/src/iam-authentication-v1-authentication.public.d.ts +3 -3
  32. package/build/es/src/iam-authentication-v1-authentication.public.js +3 -3
  33. package/build/es/src/iam-authentication-v1-authentication.public.js.map +1 -1
  34. package/build/es/src/iam-authentication-v1-authentication.types.d.ts +91 -21
  35. package/build/es/src/iam-authentication-v1-authentication.types.js.map +1 -1
  36. package/build/es/src/iam-authentication-v1-authentication.universal.d.ts +118 -34
  37. package/build/es/src/iam-authentication-v1-authentication.universal.js +24 -11
  38. package/build/es/src/iam-authentication-v1-authentication.universal.js.map +1 -1
  39. package/build/es/src/iam-recovery-v1-recovery.http.d.ts +4 -1
  40. package/build/es/src/iam-recovery-v1-recovery.http.js +4 -1
  41. package/build/es/src/iam-recovery-v1-recovery.http.js.map +1 -1
  42. package/build/es/src/iam-recovery-v1-recovery.types.d.ts +76 -15
  43. package/build/es/src/iam-recovery-v1-recovery.types.js.map +1 -1
  44. package/build/es/src/iam-recovery-v1-recovery.universal.d.ts +81 -19
  45. package/build/es/src/iam-recovery-v1-recovery.universal.js +3 -2
  46. package/build/es/src/iam-recovery-v1-recovery.universal.js.map +1 -1
  47. package/build/es/src/iam-verification-v1-start-response.http.d.ts +7 -3
  48. package/build/es/src/iam-verification-v1-start-response.http.js +7 -3
  49. package/build/es/src/iam-verification-v1-start-response.http.js.map +1 -1
  50. package/build/es/src/iam-verification-v1-start-response.types.d.ts +73 -12
  51. package/build/es/src/iam-verification-v1-start-response.types.js.map +1 -1
  52. package/build/es/src/iam-verification-v1-start-response.universal.d.ts +82 -17
  53. package/build/es/src/iam-verification-v1-start-response.universal.js +8 -4
  54. package/build/es/src/iam-verification-v1-start-response.universal.js.map +1 -1
  55. package/package.json +2 -2
@@ -1,5 +1,5 @@
1
1
  import { HttpClient } from '@wix/sdk-types';
2
- import { Identity, Identifier, LoginId, GenerateSessionTokenOptions, LoginOptions, LoginV2Options, LogoutOptions, ProceedToNextStateOptions, RegisterOptions, RegisterV2Options } from './iam-authentication-v1-authentication.universal';
2
+ import { Identity, Identifier, LoginId, LoginOptions, LoginV2Options, LogoutOptions, ProceedToNextStateOptions, RegisterOptions, RegisterV2Options, SignOnOptions } from './iam-authentication-v1-authentication.universal';
3
3
  export declare const __metadata: {
4
4
  PACKAGE_NAME: string;
5
5
  };
@@ -8,7 +8,7 @@ export declare function login(httpClient: HttpClient): (identifier: Identifier,
8
8
  export declare function registerV2(httpClient: HttpClient): (loginId: LoginId, options?: RegisterV2Options | undefined) => Promise<import("./iam-authentication-v1-authentication.universal").StateMachineResponse>;
9
9
  export declare function loginV2(httpClient: HttpClient): (loginId: LoginId, options?: LoginV2Options | undefined) => Promise<import("./iam-authentication-v1-authentication.universal").StateMachineResponse>;
10
10
  export declare function proceedToNextState(httpClient: HttpClient): (options?: ProceedToNextStateOptions | undefined) => Promise<import("./iam-authentication-v1-authentication.universal").LoginResponse>;
11
- export declare function generateSessionToken(httpClient: HttpClient): (loginId: LoginId, options?: GenerateSessionTokenOptions | undefined) => Promise<import("./iam-authentication-v1-authentication.universal").GenerateSessionTokenResponse>;
11
+ export declare function signOn(httpClient: HttpClient): (loginId: LoginId, options?: SignOnOptions | undefined) => Promise<import("./iam-authentication-v1-authentication.universal").SignOnResponse>;
12
12
  export declare function logout(httpClient: HttpClient): (options?: LogoutOptions | undefined) => Promise<import("./iam-authentication-v1-authentication.universal").RawHttpResponse>;
13
13
  export { PrivacyStatus, EmailTag, PhoneTag, AddressTag, StatusName, Reason, StateStatus, StateType, TenantType, } from './iam-authentication-v1-authentication.universal';
14
- export { Authentication, RegisterRequest, Identity, Identifier, IdentifierValueOneOf, Connection, ConnectionTypeOneOf, IdpConnection, AuthenticatorConnection, IdentityProfile, CustomField, CustomValue, CustomValueValueOneOf, ListValue, MapValue, SecondaryEmail, Phone, AddressWrapper, Address, Metadata, Email, StatusV2, CaptchaToken, CaptchaTokenTokenOneOf, LoginResponse, State, LoginRequest, LoginId, LoginIdTypeOneOf, SuccessfulLoginEvent, RegisterV2Request, StateMachineResponse, LoginV2Request, LoginWithIdpConnectionRequest, RawHttpResponse, HeadersEntry, RawHttpRequest, PathParametersEntry, QueryParametersEntry, ProceedToNextStateRequest, GenerateSessionTokenRequest, GenerateSessionTokenResponse, LogoutRequest, RegisterOptions, LoginOptions, RegisterV2Options, LoginV2Options, ProceedToNextStateOptions, GenerateSessionTokenOptions, LogoutOptions, } from './iam-authentication-v1-authentication.universal';
14
+ export { Authentication, RegisterRequest, Identity, Identifier, IdentifierValueOneOf, Connection, ConnectionTypeOneOf, IdpConnection, AuthenticatorConnection, IdentityProfile, CustomField, CustomValue, CustomValueValueOneOf, ListValue, MapValue, SecondaryEmail, Phone, AddressWrapper, Address, Metadata, Email, StatusV2, CaptchaToken, CaptchaTokenTokenOneOf, LoginResponse, State, LoginRequest, LoginId, LoginIdTypeOneOf, SuccessfulLoginEvent, RegisterV2Request, StateMachineResponse, LoginV2Request, LoginWithIdpConnectionRequest, RawHttpResponse, HeadersEntry, RawHttpRequest, PathParametersEntry, QueryParametersEntry, LoginCallbackRequest, ProceedToNextStateRequest, SignOnRequest, SignOnResponse, LogoutRequest, RegisterOptions, LoginOptions, RegisterV2Options, LoginV2Options, ProceedToNextStateOptions, SignOnOptions, LogoutOptions, } from './iam-authentication-v1-authentication.universal';
@@ -1,4 +1,4 @@
1
- import { register as universalRegister, login as universalLogin, registerV2 as universalRegisterV2, loginV2 as universalLoginV2, proceedToNextState as universalProceedToNextState, generateSessionToken as universalGenerateSessionToken, logout as universalLogout, } from './iam-authentication-v1-authentication.universal';
1
+ import { register as universalRegister, login as universalLogin, registerV2 as universalRegisterV2, loginV2 as universalLoginV2, proceedToNextState as universalProceedToNextState, signOn as universalSignOn, logout as universalLogout, } from './iam-authentication-v1-authentication.universal';
2
2
  export const __metadata = { PACKAGE_NAME: '@wix/identity' };
3
3
  export function register(httpClient) {
4
4
  return (identity, options) => universalRegister(identity, options,
@@ -25,8 +25,8 @@ export function proceedToNextState(httpClient) {
25
25
  // @ts-ignore
26
26
  { httpClient });
27
27
  }
28
- export function generateSessionToken(httpClient) {
29
- return (loginId, options) => universalGenerateSessionToken(loginId, options,
28
+ export function signOn(httpClient) {
29
+ return (loginId, options) => universalSignOn(loginId, options,
30
30
  // @ts-ignore
31
31
  { httpClient });
32
32
  }
@@ -1 +1 @@
1
- {"version":3,"file":"iam-authentication-v1-authentication.public.js","sourceRoot":"","sources":["../../../src/iam-authentication-v1-authentication.public.ts"],"names":[],"mappings":"AACA,OAAO,EACL,QAAQ,IAAI,iBAAiB,EAC7B,KAAK,IAAI,cAAc,EACvB,UAAU,IAAI,mBAAmB,EACjC,OAAO,IAAI,gBAAgB,EAC3B,kBAAkB,IAAI,2BAA2B,EACjD,oBAAoB,IAAI,6BAA6B,EACrD,MAAM,IAAI,eAAe,GAW1B,MAAM,kDAAkD,CAAC;AAE1D,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC;AAE5D,MAAM,UAAU,QAAQ,CAAC,UAAsB;IAC7C,OAAO,CAAC,QAAkB,EAAE,OAAyB,EAAE,EAAE,CACvD,iBAAiB,CACf,QAAQ,EACR,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,KAAK,CAAC,UAAsB;IAC1C,OAAO,CAAC,UAAsB,EAAE,OAAsB,EAAE,EAAE,CACxD,cAAc,CACZ,UAAU,EACV,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,UAAsB;IAC/C,OAAO,CAAC,OAAgB,EAAE,OAA2B,EAAE,EAAE,CACvD,mBAAmB,CACjB,OAAO,EACP,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,UAAsB;IAC5C,OAAO,CAAC,OAAgB,EAAE,OAAwB,EAAE,EAAE,CACpD,gBAAgB,CACd,OAAO,EACP,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,UAAsB;IACvD,OAAO,CAAC,OAAmC,EAAE,EAAE,CAC7C,2BAA2B,CACzB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,UAAsB;IACzD,OAAO,CAAC,OAAgB,EAAE,OAAqC,EAAE,EAAE,CACjE,6BAA6B,CAC3B,OAAO,EACP,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,UAAsB;IAC3C,OAAO,CAAC,OAAuB,EAAE,EAAE,CACjC,eAAe,CACb,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,OAAO,EACL,aAAa,EACb,QAAQ,EACR,QAAQ,EACR,UAAU,EACV,UAAU,EACV,MAAM,EACN,WAAW,EACX,SAAS,EACT,UAAU,GACX,MAAM,kDAAkD,CAAC"}
1
+ {"version":3,"file":"iam-authentication-v1-authentication.public.js","sourceRoot":"","sources":["../../../src/iam-authentication-v1-authentication.public.ts"],"names":[],"mappings":"AACA,OAAO,EACL,QAAQ,IAAI,iBAAiB,EAC7B,KAAK,IAAI,cAAc,EACvB,UAAU,IAAI,mBAAmB,EACjC,OAAO,IAAI,gBAAgB,EAC3B,kBAAkB,IAAI,2BAA2B,EACjD,MAAM,IAAI,eAAe,EACzB,MAAM,IAAI,eAAe,GAW1B,MAAM,kDAAkD,CAAC;AAE1D,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC;AAE5D,MAAM,UAAU,QAAQ,CAAC,UAAsB;IAC7C,OAAO,CAAC,QAAkB,EAAE,OAAyB,EAAE,EAAE,CACvD,iBAAiB,CACf,QAAQ,EACR,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,KAAK,CAAC,UAAsB;IAC1C,OAAO,CAAC,UAAsB,EAAE,OAAsB,EAAE,EAAE,CACxD,cAAc,CACZ,UAAU,EACV,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,UAAsB;IAC/C,OAAO,CAAC,OAAgB,EAAE,OAA2B,EAAE,EAAE,CACvD,mBAAmB,CACjB,OAAO,EACP,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,UAAsB;IAC5C,OAAO,CAAC,OAAgB,EAAE,OAAwB,EAAE,EAAE,CACpD,gBAAgB,CACd,OAAO,EACP,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,UAAsB;IACvD,OAAO,CAAC,OAAmC,EAAE,EAAE,CAC7C,2BAA2B,CACzB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,UAAsB;IAC3C,OAAO,CAAC,OAAgB,EAAE,OAAuB,EAAE,EAAE,CACnD,eAAe,CACb,OAAO,EACP,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,UAAsB;IAC3C,OAAO,CAAC,OAAuB,EAAE,EAAE,CACjC,eAAe,CACb,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,OAAO,EACL,aAAa,EACb,QAAQ,EACR,QAAQ,EACR,UAAU,EACV,UAAU,EACV,MAAM,EACN,WAAW,EACX,SAAS,EACT,UAAU,GACX,MAAM,kDAAkD,CAAC"}
@@ -10,25 +10,35 @@ export interface RegisterRequest {
10
10
  export interface Identity {
11
11
  /** Identity ID */
12
12
  id?: string | null;
13
+ /** Identifiers */
13
14
  identifiers?: Identifier[];
14
- /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision */
15
+ /**
16
+ * Represents the current state of an item. Each time the item is modified, its `revision` changes.
17
+ * For an update operation to succeed, you MUST pass the latest revision.
18
+ */
15
19
  revision?: string | null;
16
20
  /**
17
- * Represents the time this Identity was created
21
+ * The time this identity was created.
18
22
  * @readonly
19
23
  */
20
24
  createdDate?: Date;
21
25
  /**
22
- * Represents the time this Identity was last updated
26
+ * The time this identity was last updated.
23
27
  * @readonly
24
28
  */
25
29
  updatedDate?: Date;
26
- /** All the identity configured connections to authenticate with */
30
+ /** The identity configured connections to authenticate with. */
27
31
  connections?: Connection[];
32
+ /** Identity profile. */
28
33
  identityProfile?: IdentityProfile;
29
- /** Stores additional information about the identity that can impact user access. This data can't be set by users. */
34
+ /**
35
+ * Additional information about the identity that can impact user access.
36
+ * This data cannot be set.
37
+ */
30
38
  metadata?: Metadata;
39
+ /** Identity email address. */
31
40
  email?: Email;
41
+ /** Identity's current status. */
32
42
  status?: StatusV2;
33
43
  }
34
44
  export interface Identifier extends IdentifierValueOneOf {
@@ -41,39 +51,65 @@ export interface IdentifierValueOneOf {
41
51
  userName?: string;
42
52
  }
43
53
  export interface Connection extends ConnectionTypeOneOf {
54
+ /** IDP connection. */
44
55
  idpConnection?: IdpConnection;
56
+ /** Authenticator connection. */
45
57
  authenticatorConnection?: AuthenticatorConnection;
46
58
  }
47
59
  /** @oneof */
48
60
  export interface ConnectionTypeOneOf {
61
+ /** IDP connection. */
49
62
  idpConnection?: IdpConnection;
63
+ /** Authenticator connection. */
50
64
  authenticatorConnection?: AuthenticatorConnection;
51
65
  }
52
66
  export interface IdpConnection {
67
+ /** IDP connection ID. */
53
68
  idpConnectionId?: string;
69
+ /** IDP user ID. */
54
70
  idpUserId?: string;
55
71
  }
56
72
  export interface AuthenticatorConnection {
73
+ /** Authenticator connection ID. */
57
74
  authenticatorConnectionId?: string;
75
+ /** Whether re-enrollment is required. */
58
76
  reEnrollmentRequired?: boolean;
59
77
  }
60
78
  export interface IdentityProfile {
79
+ /** Profile first name. */
61
80
  firstName?: string | null;
81
+ /** Profile last name. */
62
82
  lastName?: string | null;
83
+ /** Profile nickname. */
63
84
  nickname?: string | null;
85
+ /** Profile picture URL. */
64
86
  picture?: string | null;
87
+ /** Deprecated. Use `secondaryEmails` instead. */
65
88
  emails?: string[];
89
+ /** Deprecated. Use `phonesV2` instead. */
66
90
  phones?: string[];
91
+ /** List of profile labels. */
67
92
  labels?: string[];
93
+ /** Profile language. */
68
94
  language?: string | null;
95
+ /** Profile privacy status. */
69
96
  privacyStatus?: PrivacyStatus;
70
- /** custom profile fields */
97
+ /**
98
+ * Any number of custom fields. [Custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)
99
+ * are used to store additional information about your site or app's contacts.
100
+ */
71
101
  customFields?: CustomField[];
102
+ /** List of profile email addresses. */
72
103
  secondaryEmails?: SecondaryEmail[];
104
+ /** List of profile phone numbers. */
73
105
  phonesV2?: Phone[];
106
+ /** List of profile physical addresses. */
74
107
  addresses?: AddressWrapper[];
108
+ /** Company name. */
75
109
  company?: string | null;
110
+ /** Position within company. */
76
111
  position?: string | null;
112
+ /** Profile birthdate. */
77
113
  birthdate?: string | null;
78
114
  }
79
115
  export declare enum PrivacyStatus {
@@ -82,32 +118,52 @@ export declare enum PrivacyStatus {
82
118
  PRIVATE = "PRIVATE"
83
119
  }
84
120
  export interface CustomField {
121
+ /**
122
+ * Custom field name. The name must match one of the key properties of the objects returned by
123
+ * [`List Extended Fields`](https://dev.wix.com/docs/rest/api-reference/contacts/extended-fields/list-extended-fields)
124
+ * with the `custom.` prefix removed.
125
+ */
85
126
  name?: string;
127
+ /** Custom field value. */
86
128
  value?: CustomValue;
87
129
  }
88
130
  export interface CustomValue extends CustomValueValueOneOf {
131
+ /** String value. */
89
132
  strValue?: string;
133
+ /** Number value. */
90
134
  numValue?: number;
135
+ /** Date value. */
91
136
  dateValue?: Date;
137
+ /** List value. */
92
138
  listValue?: ListValue;
139
+ /** Map value. */
93
140
  mapValue?: MapValue;
94
141
  }
95
142
  /** @oneof */
96
143
  export interface CustomValueValueOneOf {
144
+ /** String value. */
97
145
  strValue?: string;
146
+ /** Number value. */
98
147
  numValue?: number;
148
+ /** Date value. */
99
149
  dateValue?: Date;
150
+ /** List value. */
100
151
  listValue?: ListValue;
152
+ /** Map value. */
101
153
  mapValue?: MapValue;
102
154
  }
103
155
  export interface ListValue {
156
+ /** Custom value. */
104
157
  value?: CustomValue[];
105
158
  }
106
159
  export interface MapValue {
160
+ /** Mapped custom value. */
107
161
  value?: Record<string, CustomValue>;
108
162
  }
109
163
  export interface SecondaryEmail {
164
+ /** Email address. */
110
165
  email?: string;
166
+ /** Email tag. */
111
167
  tag?: EmailTag;
112
168
  }
113
169
  export declare enum EmailTag {
@@ -117,8 +173,11 @@ export declare enum EmailTag {
117
173
  WORK = "WORK"
118
174
  }
119
175
  export interface Phone {
176
+ /** Phone country code. */
120
177
  countryCode?: string | null;
178
+ /** Phone number. */
121
179
  phone?: string;
180
+ /** Phone tag. */
122
181
  tag?: PhoneTag;
123
182
  }
124
183
  export declare enum PhoneTag {
@@ -130,7 +189,9 @@ export declare enum PhoneTag {
130
189
  FAX = "FAX"
131
190
  }
132
191
  export interface AddressWrapper {
192
+ /** Address. */
133
193
  address?: Address;
194
+ /** Address tag. */
134
195
  tag?: AddressTag;
135
196
  }
136
197
  /** Physical address */
@@ -217,33 +278,35 @@ export interface LoginRequest {
217
278
  loginId?: LoginId;
218
279
  }
219
280
  export interface LoginId extends LoginIdTypeOneOf {
281
+ /** Login email address. */
220
282
  email?: string;
221
283
  }
222
284
  /** @oneof */
223
285
  export interface LoginIdTypeOneOf {
286
+ /** Login email address. */
224
287
  email?: string;
225
288
  }
226
289
  export interface SuccessfulLoginEvent {
227
290
  identity?: Identity;
228
291
  }
229
292
  export interface RegisterV2Request {
230
- /** the identifier of the identity */
293
+ /** Identifier of registering member. */
231
294
  loginId: LoginId;
232
- /** the password of the identity */
295
+ /** Password of registering member. */
233
296
  password?: string;
234
- /** profile of the identity */
297
+ /** Profile information of registering member. */
235
298
  profile?: IdentityProfile;
236
- /** captcha tokens - necessary when the captcha settings is on */
299
+ /** CAPTCHA tokens, when CAPTCHA setting is on. */
237
300
  captchaTokens?: CaptchaToken[];
238
301
  }
239
302
  export interface StateMachineResponse {
240
- /** The current state */
303
+ /** The current state of the login or registration process. */
241
304
  state?: StateType;
242
- /** Session token - will be returned only when the state is success */
305
+ /** If state is `SUCCESS`, a session token. */
243
306
  sessionToken?: string | null;
244
- /** State token */
307
+ /** A token representing the current state of the login or registration process. */
245
308
  stateToken?: string | null;
246
- /** The current identity */
309
+ /** Identing of the current member. */
247
310
  identity?: Identity;
248
311
  }
249
312
  export declare enum StateType {
@@ -254,11 +317,11 @@ export declare enum StateType {
254
317
  STATUS_CHECK = "STATUS_CHECK"
255
318
  }
256
319
  export interface LoginV2Request {
257
- /** the identifier of the identity */
320
+ /** Identifier of member logging in. */
258
321
  loginId: LoginId;
259
- /** the password of the identity */
322
+ /** Password of the member logging in. */
260
323
  password?: string;
261
- /** captcha tokens - necessary when the captcha settings is on */
324
+ /** CAPTCHA tokens, when CAPTCHA setting is on. */
262
325
  captchaTokens?: CaptchaToken[];
263
326
  }
264
327
  export interface LoginWithIdpConnectionRequest {
@@ -309,20 +372,27 @@ export interface QueryParametersEntry {
309
372
  key?: string;
310
373
  value?: string;
311
374
  }
375
+ export interface LoginCallbackRequest {
376
+ /** state that that received on the redirect */
377
+ state?: string;
378
+ /** session token */
379
+ sessionToken?: string;
380
+ }
312
381
  export interface ProceedToNextStateRequest {
382
+ /** State token received from the previous step in the registration or login process. */
313
383
  stateToken?: string;
314
384
  }
315
- export interface GenerateSessionTokenRequest {
385
+ export interface SignOnRequest {
316
386
  /** the identifier of the identity */
317
387
  loginId: LoginId;
318
388
  /** profile of the identity */
319
389
  profile?: IdentityProfile;
320
390
  /** when true will mark the email of the identity as verified */
321
391
  verifyEmail?: boolean;
322
- /** when true will merge the existing contact into the new created identity instead of creating a new contact */
323
- mergeExistingContact?: boolean | null;
392
+ /** when false will create a new contact instead of merging the existing contact into the identity */
393
+ mergeExistingContact?: boolean;
324
394
  }
325
- export interface GenerateSessionTokenResponse {
395
+ export interface SignOnResponse {
326
396
  /** session token for the requested identity */
327
397
  sessionToken?: string;
328
398
  }
@@ -1 +1 @@
1
- {"version":3,"file":"iam-authentication-v1-authentication.types.js","sourceRoot":"","sources":["../../../src/iam-authentication-v1-authentication.types.ts"],"names":[],"mappings":"AAuFA,MAAM,CAAN,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,wCAAuB,CAAA;IACvB,kCAAiB,CAAA;IACjB,oCAAmB,CAAA;AACrB,CAAC,EAJW,aAAa,KAAb,aAAa,QAIxB;AAqCD,MAAM,CAAN,IAAY,QAKX;AALD,WAAY,QAAQ;IAClB,iCAAqB,CAAA;IACrB,yBAAa,CAAA;IACb,yBAAa,CAAA;IACb,yBAAa,CAAA;AACf,CAAC,EALW,QAAQ,KAAR,QAAQ,QAKnB;AAQD,MAAM,CAAN,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,iCAAqB,CAAA;IACrB,yBAAa,CAAA;IACb,yBAAa,CAAA;IACb,6BAAiB,CAAA;IACjB,yBAAa,CAAA;IACb,uBAAW,CAAA;AACb,CAAC,EAPW,QAAQ,KAAR,QAAQ,QAOnB;AAuBD,MAAM,CAAN,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,mCAAqB,CAAA;IACrB,2BAAa,CAAA;IACb,2BAAa,CAAA;IACb,iCAAmB,CAAA;IACnB,mCAAqB,CAAA;AACvB,CAAC,EANW,UAAU,KAAV,UAAU,QAMrB;AAoBD,MAAM,CAAN,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,+CAAiC,CAAA;IACjC,iCAAmB,CAAA;IACnB,+BAAiB,CAAA;IACjB,iCAAmB,CAAA;IACnB,iCAAmB,CAAA;AACrB,CAAC,EANW,UAAU,KAAV,UAAU,QAMrB;AAED,MAAM,CAAN,IAAY,MAIX;AAJD,WAAY,MAAM;IAChB,2CAAiC,CAAA;IACjC,6EAAmE,CAAA;IACnE,qFAA2E,CAAA;AAC7E,CAAC,EAJW,MAAM,KAAN,MAAM,QAIjB;AA0BD,MAAM,CAAN,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,4BAAa,CAAA;IACb,gEAAiD,CAAA;IACjD,4CAA6B,CAAA;AAC/B,CAAC,EAJW,WAAW,KAAX,WAAW,QAItB;AA+CD,MAAM,CAAN,IAAY,SAMX;AAND,WAAY,SAAS;IACnB,4CAA+B,CAAA;IAC/B,gCAAmB,CAAA;IACnB,8DAAiD,CAAA;IACjD,sEAAyD,CAAA;IACzD,0CAA6B,CAAA;AAC/B,CAAC,EANW,SAAS,KAAT,SAAS,QAMpB;AA4BD,MAAM,CAAN,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,yDAA2C,CAAA;IAC3C,iCAAmB,CAAA;IACnB,2BAAa,CAAA;IACb,2BAAa,CAAA;AACf,CAAC,EALW,UAAU,KAAV,UAAU,QAKrB"}
1
+ {"version":3,"file":"iam-authentication-v1-authentication.types.js","sourceRoot":"","sources":["../../../src/iam-authentication-v1-authentication.types.ts"],"names":[],"mappings":"AA2HA,MAAM,CAAN,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,wCAAuB,CAAA;IACvB,kCAAiB,CAAA;IACjB,oCAAmB,CAAA;AACrB,CAAC,EAJW,aAAa,KAAb,aAAa,QAIxB;AAyDD,MAAM,CAAN,IAAY,QAKX;AALD,WAAY,QAAQ;IAClB,iCAAqB,CAAA;IACrB,yBAAa,CAAA;IACb,yBAAa,CAAA;IACb,yBAAa,CAAA;AACf,CAAC,EALW,QAAQ,KAAR,QAAQ,QAKnB;AAWD,MAAM,CAAN,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,iCAAqB,CAAA;IACrB,yBAAa,CAAA;IACb,yBAAa,CAAA;IACb,6BAAiB,CAAA;IACjB,yBAAa,CAAA;IACb,uBAAW,CAAA;AACb,CAAC,EAPW,QAAQ,KAAR,QAAQ,QAOnB;AAyBD,MAAM,CAAN,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,mCAAqB,CAAA;IACrB,2BAAa,CAAA;IACb,2BAAa,CAAA;IACb,iCAAmB,CAAA;IACnB,mCAAqB,CAAA;AACvB,CAAC,EANW,UAAU,KAAV,UAAU,QAMrB;AAoBD,MAAM,CAAN,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,+CAAiC,CAAA;IACjC,iCAAmB,CAAA;IACnB,+BAAiB,CAAA;IACjB,iCAAmB,CAAA;IACnB,iCAAmB,CAAA;AACrB,CAAC,EANW,UAAU,KAAV,UAAU,QAMrB;AAED,MAAM,CAAN,IAAY,MAIX;AAJD,WAAY,MAAM;IAChB,2CAAiC,CAAA;IACjC,6EAAmE,CAAA;IACnE,qFAA2E,CAAA;AAC7E,CAAC,EAJW,MAAM,KAAN,MAAM,QAIjB;AA0BD,MAAM,CAAN,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,4BAAa,CAAA;IACb,gEAAiD,CAAA;IACjD,4CAA6B,CAAA;AAC/B,CAAC,EAJW,WAAW,KAAX,WAAW,QAItB;AAiDD,MAAM,CAAN,IAAY,SAMX;AAND,WAAY,SAAS;IACnB,4CAA+B,CAAA;IAC/B,gCAAmB,CAAA;IACnB,8DAAiD,CAAA;IACjD,sEAAyD,CAAA;IACzD,0CAA6B,CAAA;AAC/B,CAAC,EANW,SAAS,KAAT,SAAS,QAMpB;AA4BD,MAAM,CAAN,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,yDAA2C,CAAA;IAC3C,iCAAmB,CAAA;IACnB,2BAAa,CAAA;IACb,2BAAa,CAAA;AACf,CAAC,EALW,UAAU,KAAV,UAAU,QAKrB"}