CognitiveX Docs
SDK

signup

Function from @cognitivx/api-client

signup

Kind: Function Source: packages/api-client/src/endpoints/auth.ts:18 Generated from the TypeScript source for @cognitivx/api-client.

Signature

signup(body)

Parameters

[
  {
    "name": "body",
    "type": {
      "type": "reflection",
      "declaration": {
        "id": 205,
        "name": "__type",
        "variant": "declaration",
        "kind": 65536,
        "flags": {},
        "children": [
          {
            "id": 208,
            "name": "display_name",
            "variant": "declaration",
            "kind": 1024,
            "flags": {
              "isOptional": true
            },
            "sources": [
              {
                "fileName": "packages/api-client/src/endpoints/auth.ts",
                "line": 18,
                "character": 64,
                "url": "https://github.com/ParsaBarati/CognitiveX/blob/1090be99c91b488bd57bc6c8e9230d568d32dad0/packages/api-client/src/endpoints/auth.ts#L18"
              }
            ],
            "type": {
              "type": "intrinsic",
              "name": "string"
            }
          },
          {
            "id": 206,
            "name": "email",
            "variant": "declaration",
            "kind": 1024,
            "flags": {},
            "sources": [
              {
                "fileName": "packages/api-client/src/endpoints/auth.ts",
                "line": 18,
                "character": 31,
                "url": "https://github.com/ParsaBarati/CognitiveX/blob/1090be99c91b488bd57bc6c8e9230d568d32dad0/packages/api-client/src/endpoints/auth.ts#L18"
              }
            ],
            "type": {
              "type": "intrinsic",
              "name": "string"
            }
          },
          {
            "id": 207,
            "name": "password",
            "variant": "declaration",
            "kind": 1024,
            "flags": {},
            "sources": [
              {
                "fileName": "packages/api-client/src/endpoints/auth.ts",
                "line": 18,
                "character": 46,
                "url": "https://github.com/ParsaBarati/CognitiveX/blob/1090be99c91b488bd57bc6c8e9230d568d32dad0/packages/api-client/src/endpoints/auth.ts#L18"
              }
            ],
            "type": {
              "type": "intrinsic",
              "name": "string"
            }
          }
        ],
        "groups": [
          {
            "title": "Properties",
            "children": [
              208,
              206,
              207
            ]
          }
        ]
      }
    },
    "summary": ""
  }
]

TypeDoc reflection

{
  "name": "signup",
  "kind": "Function",
  "source": "packages/api-client/src/endpoints/auth.ts:18"
}