onehook-api-client 1.0.38 → 1.0.39

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.
@@ -31,10 +31,11 @@ declare const CreateAdminInviteCommand_base: {
31
31
  * module. Internal, IAM-authorized (SigV4) — NOT the Cognito user-pool authorizer — so the only
32
32
  * callers are principals granted \{@code execute-api:Invoke\} (the portal's per-module invoke role).
33
33
  *
34
- * The invite is bound to the HMAC hash of the E.164 phone number, created with \{@code maxUses=1\} and
35
- * a short TTL (default 14 days, bounded 1..30). \{@code RegisterPhone\} refuses a bound invite when the
36
- * registering phone's hash differs, with the SAME error as an invalid/unknown invite, so the binding
37
- * is never revealed. The response never echoes the phone or its hash.
34
+ * Created with \{@code maxUses=1\} and a short TTL (default 14 days, bounded 1..30). With a
35
+ * \{@code phoneNumber\}, the invite is bound to the HMAC hash of that E.164 number: \{@code RegisterPhone\}
36
+ * refuses it for any other phone, with the SAME error as an invalid/unknown invite, so the binding is
37
+ * never revealed. Without one, the invite is unbound and any phone may redeem it. The response never
38
+ * echoes the phone or its hash.
38
39
  * @example
39
40
  * Use a bare-bones client and the command you need to make an API call.
40
41
  * ```javascript
@@ -42,7 +43,7 @@ declare const CreateAdminInviteCommand_base: {
42
43
  * // const { OneHookClient, CreateAdminInviteCommand } = require("onehook-api-client"); // CommonJS import
43
44
  * const client = new OneHookClient(config);
44
45
  * const input = { // CreateAdminInviteRequest
45
- * phoneNumber: "STRING_VALUE", // required
46
+ * phoneNumber: "STRING_VALUE",
46
47
  * referrerId: "STRING_VALUE", // required
47
48
  * ttlDays: Number("int"),
48
49
  * };
@@ -1373,7 +1373,11 @@ export interface AuthSocialResponse {
1373
1373
  * @public
1374
1374
  */
1375
1375
  export interface CreateAdminInviteRequest {
1376
- phoneNumber: string | undefined;
1376
+ /**
1377
+ * E.164 phone the invite is bound to. Omit for an unbound invite any phone may redeem.
1378
+ * @public
1379
+ */
1380
+ phoneNumber?: string | undefined;
1377
1381
  referrerId: string | undefined;
1378
1382
  /**
1379
1383
  * Optional invite lifetime in days. Defaults to 14 when omitted; bounded to 1..30.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "onehook-api-client",
3
3
  "description": "OneHook API Client",
4
- "version": "1.0.38",
4
+ "version": "1.0.39",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",