onehook-api-client 1.0.30 → 1.0.32
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.
- package/README.md +49 -0
- package/dist-cjs/OneHook.js +14 -0
- package/dist-cjs/commands/CorrectBirthDateCommand.js +21 -0
- package/dist-cjs/commands/GetBirthDateStatusCommand.js +21 -0
- package/dist-cjs/commands/GetPlaceCommand.js +21 -0
- package/dist-cjs/commands/GetPreservationHoldCommand.js +21 -0
- package/dist-cjs/commands/RevokeUserAccessCommand.js +21 -0
- package/dist-cjs/commands/SearchPlacesCommand.js +21 -0
- package/dist-cjs/commands/SetPreservationHoldCommand.js +21 -0
- package/dist-cjs/commands/index.js +7 -0
- package/dist-cjs/protocols/Aws_restJson1.js +274 -4
- package/dist-cjs/telemetry/index.js +5 -3
- package/dist-es/OneHook.js +14 -0
- package/dist-es/commands/CorrectBirthDateCommand.js +17 -0
- package/dist-es/commands/GetBirthDateStatusCommand.js +17 -0
- package/dist-es/commands/GetPlaceCommand.js +17 -0
- package/dist-es/commands/GetPreservationHoldCommand.js +17 -0
- package/dist-es/commands/RevokeUserAccessCommand.js +17 -0
- package/dist-es/commands/SearchPlacesCommand.js +17 -0
- package/dist-es/commands/SetPreservationHoldCommand.js +17 -0
- package/dist-es/commands/index.js +7 -0
- package/dist-es/protocols/Aws_restJson1.js +257 -1
- package/dist-es/telemetry/index.js +5 -3
- package/dist-types/OneHook.d.ts +49 -0
- package/dist-types/OneHookClient.d.ts +9 -2
- package/dist-types/commands/CorrectBirthDateCommand.d.ts +88 -0
- package/dist-types/commands/GetBirthDateStatusCommand.d.ts +89 -0
- package/dist-types/commands/GetMyProfileCommand.d.ts +10 -0
- package/dist-types/commands/GetPlaceCommand.d.ts +84 -0
- package/dist-types/commands/GetPreservationHoldCommand.d.ts +87 -0
- package/dist-types/commands/GetProfileCommand.d.ts +10 -0
- package/dist-types/commands/RevokeUserAccessCommand.d.ts +94 -0
- package/dist-types/commands/SearchPlacesCommand.d.ts +83 -0
- package/dist-types/commands/SetPreservationHoldCommand.d.ts +98 -0
- package/dist-types/commands/UpdateProfileCommand.d.ts +9 -1
- package/dist-types/commands/index.d.ts +7 -0
- package/dist-types/models/models_0.d.ts +301 -1
- package/dist-types/protocols/Aws_restJson1.d.ts +63 -0
- package/dist-types/telemetry/index.d.ts +3 -2
- package/package.json +1 -1
- package/telemetry/TelemetryCatalog.kt +6 -5
- package/telemetry/TelemetryCatalog.swift +7 -5
- package/telemetry/telemetry-catalog.json +25 -4
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
|
|
2
|
+
import { SetPreservationHoldRequest, SetPreservationHoldResponse } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link SetPreservationHoldCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface SetPreservationHoldCommandInput extends SetPreservationHoldRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link SetPreservationHoldCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface SetPreservationHoldCommandOutput extends SetPreservationHoldResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const SetPreservationHoldCommand_base: {
|
|
25
|
+
new (input: SetPreservationHoldCommandInput): import("@smithy/smithy-client").CommandImpl<SetPreservationHoldCommandInput, SetPreservationHoldCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: SetPreservationHoldCommandInput): import("@smithy/smithy-client").CommandImpl<SetPreservationHoldCommandInput, SetPreservationHoldCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Sets or releases a legal preservation hold on a member, for suspected child sexual abuse or
|
|
31
|
+
* exploitation and other legal-hold cases (IT Rules 2021 r.3(1)(g)). Internal, IAM-authorized
|
|
32
|
+
* (SigV4) - NOT the Cognito user-pool authorizer - so the only caller is the admin portal's
|
|
33
|
+
* moderation module (its per-module invoke role). The write is optimistic-concurrency guarded: pass
|
|
34
|
+
* the `expectedVersion` read from GetPreservationHold and a concurrent change returns 409. Emits a
|
|
35
|
+
* `PreservationHoldChanged` domain event through the Identity transactional outbox. No free text is
|
|
36
|
+
* accepted - the reason is a CODE (one of CHILD_SAFETY, LEGAL_REQUEST, OTHER_LEGAL).
|
|
37
|
+
*
|
|
38
|
+
* When activating, `until` defaults to now + 180 days and can only be extended FORWARD. Releasing
|
|
39
|
+
* (`active=false`) clears the hold so the deferred deletion can complete.
|
|
40
|
+
* @example
|
|
41
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
42
|
+
* ```javascript
|
|
43
|
+
* import { OneHookClient, SetPreservationHoldCommand } from "onehook-api-client"; // ES Modules import
|
|
44
|
+
* // const { OneHookClient, SetPreservationHoldCommand } = require("onehook-api-client"); // CommonJS import
|
|
45
|
+
* const client = new OneHookClient(config);
|
|
46
|
+
* const input = { // SetPreservationHoldRequest
|
|
47
|
+
* userId: "STRING_VALUE", // required
|
|
48
|
+
* active: true || false, // required
|
|
49
|
+
* reasonCode: "STRING_VALUE", // required
|
|
50
|
+
* until: Number("long"),
|
|
51
|
+
* actor: "STRING_VALUE", // required
|
|
52
|
+
* caseRef: "STRING_VALUE",
|
|
53
|
+
* expectedVersion: Number("int"),
|
|
54
|
+
* };
|
|
55
|
+
* const command = new SetPreservationHoldCommand(input);
|
|
56
|
+
* const response = await client.send(command);
|
|
57
|
+
* // { // SetPreservationHoldResponse
|
|
58
|
+
* // active: true || false, // required
|
|
59
|
+
* // until: Number("long"),
|
|
60
|
+
* // version: Number("int"), // required
|
|
61
|
+
* // reasonCode: "STRING_VALUE",
|
|
62
|
+
* // };
|
|
63
|
+
*
|
|
64
|
+
* ```
|
|
65
|
+
*
|
|
66
|
+
* @param SetPreservationHoldCommandInput - {@link SetPreservationHoldCommandInput}
|
|
67
|
+
* @returns {@link SetPreservationHoldCommandOutput}
|
|
68
|
+
* @see {@link SetPreservationHoldCommandInput} for command's `input` shape.
|
|
69
|
+
* @see {@link SetPreservationHoldCommandOutput} for command's `response` shape.
|
|
70
|
+
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link BadRequestError} (client fault)
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link NotFoundError} (client fault)
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ConflictError} (client fault)
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link InternalServerError} (server fault)
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link OneHookServiceException}
|
|
81
|
+
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
82
|
+
*
|
|
83
|
+
*
|
|
84
|
+
* @public
|
|
85
|
+
*/
|
|
86
|
+
export declare class SetPreservationHoldCommand extends SetPreservationHoldCommand_base {
|
|
87
|
+
/** @internal type navigation helper, not in runtime. */
|
|
88
|
+
protected static __types: {
|
|
89
|
+
api: {
|
|
90
|
+
input: SetPreservationHoldRequest;
|
|
91
|
+
output: SetPreservationHoldResponse;
|
|
92
|
+
};
|
|
93
|
+
sdk: {
|
|
94
|
+
input: SetPreservationHoldCommandInput;
|
|
95
|
+
output: SetPreservationHoldCommandOutput;
|
|
96
|
+
};
|
|
97
|
+
};
|
|
98
|
+
}
|
|
@@ -38,7 +38,6 @@ declare const UpdateProfileCommand_base: {
|
|
|
38
38
|
* const input = { // ProfileUpdateRequest
|
|
39
39
|
* displayName: "STRING_VALUE",
|
|
40
40
|
* bio: "STRING_VALUE",
|
|
41
|
-
* age: Number("int"),
|
|
42
41
|
* gender: "STRING_VALUE",
|
|
43
42
|
* interestedIn: [ // StringList
|
|
44
43
|
* "STRING_VALUE",
|
|
@@ -95,6 +94,15 @@ declare const UpdateProfileCommand_base: {
|
|
|
95
94
|
* educationLevel: "STRING_VALUE",
|
|
96
95
|
* politicalView: "STRING_VALUE",
|
|
97
96
|
* languages: "<StringList>",
|
|
97
|
+
* birthDetails: { // BirthDetails
|
|
98
|
+
* date: "STRING_VALUE",
|
|
99
|
+
* time: "STRING_VALUE",
|
|
100
|
+
* timeZone: "STRING_VALUE",
|
|
101
|
+
* latitude: Number("double"),
|
|
102
|
+
* longitude: Number("double"),
|
|
103
|
+
* placeName: "STRING_VALUE",
|
|
104
|
+
* provisional: true || false,
|
|
105
|
+
* },
|
|
98
106
|
* };
|
|
99
107
|
* const command = new UpdateProfileCommand(input);
|
|
100
108
|
* const response = await client.send(command);
|
|
@@ -16,6 +16,7 @@ export * from "./GenerateInviteCommand";
|
|
|
16
16
|
export * from "./GetAccountStateCommand";
|
|
17
17
|
export * from "./GetAdminPhoneStatusCommand";
|
|
18
18
|
export * from "./GetCredentialReadinessCommand";
|
|
19
|
+
export * from "./GetPreservationHoldCommand";
|
|
19
20
|
export * from "./GetUserCommand";
|
|
20
21
|
export * from "./GetUserByEmailCommand";
|
|
21
22
|
export * from "./GetUserIdByUsernameCommand";
|
|
@@ -25,8 +26,10 @@ export * from "./RegisterPhoneCommand";
|
|
|
25
26
|
export * from "./RequestEmailOtpCommand";
|
|
26
27
|
export * from "./RequestPhoneOtpCommand";
|
|
27
28
|
export * from "./RequestPhoneUpdateOtpCommand";
|
|
29
|
+
export * from "./RevokeUserAccessCommand";
|
|
28
30
|
export * from "./SendAdminLinkOtpCommand";
|
|
29
31
|
export * from "./SetAccountStateCommand";
|
|
32
|
+
export * from "./SetPreservationHoldCommand";
|
|
30
33
|
export * from "./UnlinkSocialCommand";
|
|
31
34
|
export * from "./UpdateEntitlementsCommand";
|
|
32
35
|
export * from "./UpdatePhoneNumberCommand";
|
|
@@ -45,13 +48,17 @@ export * from "./SwipeCommand";
|
|
|
45
48
|
export * from "./SwipeByUsernameCommand";
|
|
46
49
|
export * from "./UpdatePreferencesCommand";
|
|
47
50
|
export * from "./CompleteLivenessSessionCommand";
|
|
51
|
+
export * from "./CorrectBirthDateCommand";
|
|
48
52
|
export * from "./CreateLivenessSessionCommand";
|
|
49
53
|
export * from "./DeleteProfileCommand";
|
|
50
54
|
export * from "./GenerateDownloadUrlCommand";
|
|
51
55
|
export * from "./GenerateUploadUrlCommand";
|
|
56
|
+
export * from "./GetBirthDateStatusCommand";
|
|
52
57
|
export * from "./GetLivenessStatusCommand";
|
|
53
58
|
export * from "./GetMyProfileCommand";
|
|
59
|
+
export * from "./GetPlaceCommand";
|
|
54
60
|
export * from "./GetProfileCommand";
|
|
61
|
+
export * from "./SearchPlacesCommand";
|
|
55
62
|
export * from "./UpdateProfileCommand";
|
|
56
63
|
export * from "./CompleteOnboardingCommand";
|
|
57
64
|
export * from "./GetMatchCommand";
|
|
@@ -751,6 +751,51 @@ export interface GetCredentialReadinessResponse {
|
|
|
751
751
|
*/
|
|
752
752
|
gaps: (CredentialGap)[] | undefined;
|
|
753
753
|
}
|
|
754
|
+
/**
|
|
755
|
+
* @public
|
|
756
|
+
*/
|
|
757
|
+
export interface GetPreservationHoldRequest {
|
|
758
|
+
userId: string | undefined;
|
|
759
|
+
}
|
|
760
|
+
/**
|
|
761
|
+
* @public
|
|
762
|
+
*/
|
|
763
|
+
export interface GetPreservationHoldResponse {
|
|
764
|
+
active: boolean | undefined;
|
|
765
|
+
/**
|
|
766
|
+
* Epoch ms the hold expires; absent when inactive.
|
|
767
|
+
* @public
|
|
768
|
+
*/
|
|
769
|
+
until?: number | undefined;
|
|
770
|
+
version: number | undefined;
|
|
771
|
+
/**
|
|
772
|
+
* The reason code for the current hold; absent when inactive.
|
|
773
|
+
* @public
|
|
774
|
+
*/
|
|
775
|
+
reasonCode?: string | undefined;
|
|
776
|
+
/**
|
|
777
|
+
* Case reference for audit; absent when inactive or never set.
|
|
778
|
+
* @public
|
|
779
|
+
*/
|
|
780
|
+
caseRef?: string | undefined;
|
|
781
|
+
/**
|
|
782
|
+
* The admin actor id that last changed the hold; absent when never set.
|
|
783
|
+
* @public
|
|
784
|
+
*/
|
|
785
|
+
setBy?: string | undefined;
|
|
786
|
+
/**
|
|
787
|
+
* Epoch ms the hold was last changed; absent when never set.
|
|
788
|
+
* @public
|
|
789
|
+
*/
|
|
790
|
+
setAt?: number | undefined;
|
|
791
|
+
/**
|
|
792
|
+
* Epoch ms a CHILD_SAFETY hold was first set. Anchors the non-negotiable 180-day minimum: the
|
|
793
|
+
* hold cannot be released, nor its `until` shortened, before this instant + 180 days. Absent when
|
|
794
|
+
* the current hold is not a child-safety hold (or is inactive).
|
|
795
|
+
* @public
|
|
796
|
+
*/
|
|
797
|
+
childSafetySince?: number | undefined;
|
|
798
|
+
}
|
|
754
799
|
/**
|
|
755
800
|
* @public
|
|
756
801
|
*/
|
|
@@ -877,6 +922,22 @@ export interface RequestPhoneUpdateOtpRequest {
|
|
|
877
922
|
export interface RequestPhoneUpdateOtpResponse {
|
|
878
923
|
status: string | undefined;
|
|
879
924
|
}
|
|
925
|
+
/**
|
|
926
|
+
* @public
|
|
927
|
+
*/
|
|
928
|
+
export interface RevokeUserAccessRequest {
|
|
929
|
+
userId: string | undefined;
|
|
930
|
+
}
|
|
931
|
+
/**
|
|
932
|
+
* @public
|
|
933
|
+
*/
|
|
934
|
+
export interface RevokeUserAccessResponse {
|
|
935
|
+
/**
|
|
936
|
+
* Machine-readable outcome code (e.g. REVOKED). Never PII.
|
|
937
|
+
* @public
|
|
938
|
+
*/
|
|
939
|
+
status: string | undefined;
|
|
940
|
+
}
|
|
880
941
|
/**
|
|
881
942
|
* @public
|
|
882
943
|
*/
|
|
@@ -958,6 +1019,61 @@ export interface SetAccountStateResponse {
|
|
|
958
1019
|
until?: number | undefined;
|
|
959
1020
|
version: number | undefined;
|
|
960
1021
|
}
|
|
1022
|
+
/**
|
|
1023
|
+
* @public
|
|
1024
|
+
*/
|
|
1025
|
+
export interface SetPreservationHoldRequest {
|
|
1026
|
+
userId: string | undefined;
|
|
1027
|
+
/**
|
|
1028
|
+
* True to place/extend the hold; false to release it.
|
|
1029
|
+
* @public
|
|
1030
|
+
*/
|
|
1031
|
+
active: boolean | undefined;
|
|
1032
|
+
/**
|
|
1033
|
+
* Machine-readable reason code: one of CHILD_SAFETY, LEGAL_REQUEST, OTHER_LEGAL (never free text).
|
|
1034
|
+
* @public
|
|
1035
|
+
*/
|
|
1036
|
+
reasonCode: string | undefined;
|
|
1037
|
+
/**
|
|
1038
|
+
* Epoch ms the hold expires. Defaults to now + 180 days when activating; may only be extended
|
|
1039
|
+
* forward. Ignored when releasing.
|
|
1040
|
+
* @public
|
|
1041
|
+
*/
|
|
1042
|
+
until?: number | undefined;
|
|
1043
|
+
/**
|
|
1044
|
+
* The admin actor id taking the action (audit).
|
|
1045
|
+
* @public
|
|
1046
|
+
*/
|
|
1047
|
+
actor: string | undefined;
|
|
1048
|
+
/**
|
|
1049
|
+
* Optional case reference for audit (e.g. an NCMEC/agency ticket id). Stored in Identity only;
|
|
1050
|
+
* never travels in the PreservationHoldChanged event.
|
|
1051
|
+
* @public
|
|
1052
|
+
*/
|
|
1053
|
+
caseRef?: string | undefined;
|
|
1054
|
+
/**
|
|
1055
|
+
* Optional optimistic-concurrency token from GetPreservationHold; a mismatch returns 409.
|
|
1056
|
+
* @public
|
|
1057
|
+
*/
|
|
1058
|
+
expectedVersion?: number | undefined;
|
|
1059
|
+
}
|
|
1060
|
+
/**
|
|
1061
|
+
* @public
|
|
1062
|
+
*/
|
|
1063
|
+
export interface SetPreservationHoldResponse {
|
|
1064
|
+
active: boolean | undefined;
|
|
1065
|
+
/**
|
|
1066
|
+
* Epoch ms the hold expires; absent when released.
|
|
1067
|
+
* @public
|
|
1068
|
+
*/
|
|
1069
|
+
until?: number | undefined;
|
|
1070
|
+
version: number | undefined;
|
|
1071
|
+
/**
|
|
1072
|
+
* The reason code for the current hold; absent when released.
|
|
1073
|
+
* @public
|
|
1074
|
+
*/
|
|
1075
|
+
reasonCode?: string | undefined;
|
|
1076
|
+
}
|
|
961
1077
|
/**
|
|
962
1078
|
* @public
|
|
963
1079
|
*/
|
|
@@ -1665,6 +1781,42 @@ export interface CompleteLivenessSessionResponse {
|
|
|
1665
1781
|
*/
|
|
1666
1782
|
status: string | undefined;
|
|
1667
1783
|
}
|
|
1784
|
+
/**
|
|
1785
|
+
* @public
|
|
1786
|
+
*/
|
|
1787
|
+
export interface CorrectBirthDateRequest {
|
|
1788
|
+
userId: string | undefined;
|
|
1789
|
+
/**
|
|
1790
|
+
* The corrected birth date, `yyyy-MM-dd` (must give an age of 18 to 120).
|
|
1791
|
+
* @public
|
|
1792
|
+
*/
|
|
1793
|
+
date: string | undefined;
|
|
1794
|
+
/**
|
|
1795
|
+
* The approver's reasoning (10-500 characters), e.g. "Passport shows 1991-03-02". Kept so anyone
|
|
1796
|
+
* reviewing the change later can follow the decision.
|
|
1797
|
+
* @public
|
|
1798
|
+
*/
|
|
1799
|
+
reason: string | undefined;
|
|
1800
|
+
/**
|
|
1801
|
+
* Optional support ticket or case reference.
|
|
1802
|
+
* @public
|
|
1803
|
+
*/
|
|
1804
|
+
reference?: string | undefined;
|
|
1805
|
+
}
|
|
1806
|
+
/**
|
|
1807
|
+
* @public
|
|
1808
|
+
*/
|
|
1809
|
+
export interface CorrectBirthDateResponse {
|
|
1810
|
+
userId: string | undefined;
|
|
1811
|
+
date: string | undefined;
|
|
1812
|
+
age: number | undefined;
|
|
1813
|
+
/**
|
|
1814
|
+
* Corrections used for this member, including this one.
|
|
1815
|
+
* @public
|
|
1816
|
+
*/
|
|
1817
|
+
correctionsUsed: number | undefined;
|
|
1818
|
+
correctionsRemaining: number | undefined;
|
|
1819
|
+
}
|
|
1668
1820
|
/**
|
|
1669
1821
|
* @public
|
|
1670
1822
|
*/
|
|
@@ -1722,6 +1874,40 @@ export interface MediaUploadUrlResponse {
|
|
|
1722
1874
|
objectKey: string | undefined;
|
|
1723
1875
|
formData: Record<string, string> | undefined;
|
|
1724
1876
|
}
|
|
1877
|
+
/**
|
|
1878
|
+
* @public
|
|
1879
|
+
*/
|
|
1880
|
+
export interface GetBirthDateStatusRequest {
|
|
1881
|
+
userId: string | undefined;
|
|
1882
|
+
}
|
|
1883
|
+
/**
|
|
1884
|
+
* @public
|
|
1885
|
+
*/
|
|
1886
|
+
export interface GetBirthDateStatusResponse {
|
|
1887
|
+
userId: string | undefined;
|
|
1888
|
+
/**
|
|
1889
|
+
* `yyyy-MM-dd`; absent for a legacy profile that never had one.
|
|
1890
|
+
* @public
|
|
1891
|
+
*/
|
|
1892
|
+
date?: string | undefined;
|
|
1893
|
+
age?: number | undefined;
|
|
1894
|
+
provisional: boolean | undefined;
|
|
1895
|
+
birthDateOnFile: boolean | undefined;
|
|
1896
|
+
correctionsUsed: number | undefined;
|
|
1897
|
+
correctionsRemaining: number | undefined;
|
|
1898
|
+
/**
|
|
1899
|
+
* Epoch seconds of the most recent correction.
|
|
1900
|
+
* @public
|
|
1901
|
+
*/
|
|
1902
|
+
lastCorrectedAt?: number | undefined;
|
|
1903
|
+
lastReason?: string | undefined;
|
|
1904
|
+
lastReference?: string | undefined;
|
|
1905
|
+
/**
|
|
1906
|
+
* IAM caller ARN of the most recent correction (includes the portal admin's session name).
|
|
1907
|
+
* @public
|
|
1908
|
+
*/
|
|
1909
|
+
lastCorrectedBy?: string | undefined;
|
|
1910
|
+
}
|
|
1725
1911
|
/**
|
|
1726
1912
|
* @public
|
|
1727
1913
|
*/
|
|
@@ -1732,6 +1918,52 @@ export interface LivenessStatusResponse {
|
|
|
1732
1918
|
*/
|
|
1733
1919
|
status: string | undefined;
|
|
1734
1920
|
}
|
|
1921
|
+
/**
|
|
1922
|
+
* Birth data. `date` is required (age is derived from it); each extra field unlocks more traditional systems
|
|
1923
|
+
* (`time` + `timeZone`: Moon nakshatra, hour pillar, Zi Wei palaces; `latitude` + `longitude`:
|
|
1924
|
+
* Ascendant, Arabic Parts, Hellenistic sect). Never shown to other members.
|
|
1925
|
+
* @public
|
|
1926
|
+
*/
|
|
1927
|
+
export interface BirthDetails {
|
|
1928
|
+
/**
|
|
1929
|
+
* Local birth date (day, month and year), `yyyy-MM-dd`. Must give an age of 18 to 120.
|
|
1930
|
+
* Set once at onboarding; immutable afterwards.
|
|
1931
|
+
* @public
|
|
1932
|
+
*/
|
|
1933
|
+
date?: string | undefined;
|
|
1934
|
+
/**
|
|
1935
|
+
* Local birth time, `HH:mm` (24h). Requires `timeZone`.
|
|
1936
|
+
* @public
|
|
1937
|
+
*/
|
|
1938
|
+
time?: string | undefined;
|
|
1939
|
+
/**
|
|
1940
|
+
* IANA time zone of the birthplace, e.g. `Asia/Kolkata`.
|
|
1941
|
+
* @public
|
|
1942
|
+
*/
|
|
1943
|
+
timeZone?: string | undefined;
|
|
1944
|
+
/**
|
|
1945
|
+
* Birthplace latitude in degrees (north positive). Send together with `longitude`.
|
|
1946
|
+
* @public
|
|
1947
|
+
*/
|
|
1948
|
+
latitude?: number | undefined;
|
|
1949
|
+
/**
|
|
1950
|
+
* Birthplace longitude in degrees (east positive). Send together with `latitude`.
|
|
1951
|
+
* @public
|
|
1952
|
+
*/
|
|
1953
|
+
longitude?: number | undefined;
|
|
1954
|
+
/**
|
|
1955
|
+
* Display label of the chosen birthplace (from `GET /profile/places`). Needs latitude/longitude.
|
|
1956
|
+
* @public
|
|
1957
|
+
*/
|
|
1958
|
+
placeName?: string | undefined;
|
|
1959
|
+
/**
|
|
1960
|
+
* Server-set, ignored on input. True when `date` is a placeholder added for a profile created
|
|
1961
|
+
* before the birth date was compulsory. The member may replace a provisional date ONCE with
|
|
1962
|
+
* their real one; clients should prompt for it.
|
|
1963
|
+
* @public
|
|
1964
|
+
*/
|
|
1965
|
+
provisional?: boolean | undefined;
|
|
1966
|
+
}
|
|
1735
1967
|
/**
|
|
1736
1968
|
* A user-authored conversation opener: free text plus an optional image.
|
|
1737
1969
|
* The image (if present) is moderated by the same async decency flow as profile pictures
|
|
@@ -1757,6 +1989,10 @@ export interface ProfileResponse {
|
|
|
1757
1989
|
userId: string | undefined;
|
|
1758
1990
|
displayName?: string | undefined;
|
|
1759
1991
|
bio?: string | undefined;
|
|
1992
|
+
/**
|
|
1993
|
+
* Derived from the birth date on every read. Never stored and never settable.
|
|
1994
|
+
* @public
|
|
1995
|
+
*/
|
|
1760
1996
|
age?: number | undefined;
|
|
1761
1997
|
gender?: string | undefined;
|
|
1762
1998
|
interestedIn?: (string)[] | undefined;
|
|
@@ -1818,6 +2054,38 @@ export interface ProfileResponse {
|
|
|
1818
2054
|
educationLevel?: string | undefined;
|
|
1819
2055
|
politicalView?: string | undefined;
|
|
1820
2056
|
languages?: (string)[] | undefined;
|
|
2057
|
+
/**
|
|
2058
|
+
* The caller's own birth details. Returned only to the profile owner; absent for everyone else.
|
|
2059
|
+
* @public
|
|
2060
|
+
*/
|
|
2061
|
+
birthDetails?: BirthDetails | undefined;
|
|
2062
|
+
/**
|
|
2063
|
+
* True when a real (non-provisional) birth date is on file. Returned to every viewer; reveals
|
|
2064
|
+
* nothing about the date. State's onboarding gate requires it.
|
|
2065
|
+
* @public
|
|
2066
|
+
*/
|
|
2067
|
+
birthDateOnFile?: boolean | undefined;
|
|
2068
|
+
}
|
|
2069
|
+
/**
|
|
2070
|
+
* @public
|
|
2071
|
+
*/
|
|
2072
|
+
export interface GetPlaceRequest {
|
|
2073
|
+
placeId: string | undefined;
|
|
2074
|
+
lang?: string | undefined;
|
|
2075
|
+
}
|
|
2076
|
+
/**
|
|
2077
|
+
* @public
|
|
2078
|
+
*/
|
|
2079
|
+
export interface GetPlaceResponse {
|
|
2080
|
+
placeId: string | undefined;
|
|
2081
|
+
label: string | undefined;
|
|
2082
|
+
latitude: number | undefined;
|
|
2083
|
+
longitude: number | undefined;
|
|
2084
|
+
/**
|
|
2085
|
+
* IANA time zone, e.g. `Asia/Kolkata`. Absent when Amazon Location has none for the place.
|
|
2086
|
+
* @public
|
|
2087
|
+
*/
|
|
2088
|
+
timeZone?: string | undefined;
|
|
1821
2089
|
}
|
|
1822
2090
|
/**
|
|
1823
2091
|
* @public
|
|
@@ -1825,13 +2093,36 @@ export interface ProfileResponse {
|
|
|
1825
2093
|
export interface GetProfileRequest {
|
|
1826
2094
|
userId: string | undefined;
|
|
1827
2095
|
}
|
|
2096
|
+
/**
|
|
2097
|
+
* @public
|
|
2098
|
+
*/
|
|
2099
|
+
export interface SearchPlacesRequest {
|
|
2100
|
+
q: string | undefined;
|
|
2101
|
+
/**
|
|
2102
|
+
* BCP-47 language for labels, e.g. `en`, `hi`.
|
|
2103
|
+
* @public
|
|
2104
|
+
*/
|
|
2105
|
+
lang?: string | undefined;
|
|
2106
|
+
}
|
|
2107
|
+
/**
|
|
2108
|
+
* @public
|
|
2109
|
+
*/
|
|
2110
|
+
export interface PlaceSuggestion {
|
|
2111
|
+
placeId: string | undefined;
|
|
2112
|
+
label: string | undefined;
|
|
2113
|
+
}
|
|
2114
|
+
/**
|
|
2115
|
+
* @public
|
|
2116
|
+
*/
|
|
2117
|
+
export interface SearchPlacesResponse {
|
|
2118
|
+
places: (PlaceSuggestion)[] | undefined;
|
|
2119
|
+
}
|
|
1828
2120
|
/**
|
|
1829
2121
|
* @public
|
|
1830
2122
|
*/
|
|
1831
2123
|
export interface ProfileUpdateRequest {
|
|
1832
2124
|
displayName?: string | undefined;
|
|
1833
2125
|
bio?: string | undefined;
|
|
1834
|
-
age?: number | undefined;
|
|
1835
2126
|
gender?: string | undefined;
|
|
1836
2127
|
interestedIn?: (string)[] | undefined;
|
|
1837
2128
|
interests?: (string)[] | undefined;
|
|
@@ -1867,6 +2158,15 @@ export interface ProfileUpdateRequest {
|
|
|
1867
2158
|
educationLevel?: string | undefined;
|
|
1868
2159
|
politicalView?: string | undefined;
|
|
1869
2160
|
languages?: (string)[] | undefined;
|
|
2161
|
+
/**
|
|
2162
|
+
* Birth details. `date` is REQUIRED when the profile is first created (the member's age is
|
|
2163
|
+
* derived from it, and must be 18 or over) and can NEVER be changed afterwards: a different or
|
|
2164
|
+
* empty date returns 400 (re-sending the same date is fine). The other
|
|
2165
|
+
* fields are optional, can be added at onboarding or later, and only refine traditional
|
|
2166
|
+
* compatibility (Kundali, natal chart, Bazi, …). Omit the object to keep the stored value.
|
|
2167
|
+
* @public
|
|
2168
|
+
*/
|
|
2169
|
+
birthDetails?: BirthDetails | undefined;
|
|
1870
2170
|
}
|
|
1871
2171
|
/**
|
|
1872
2172
|
* @public
|