Skip to content

userinput.md

Latest commit

 

History

History
101 lines (96 loc) · 24.9 KB

userinput.md

File metadata and controls

101 lines (96 loc) · 24.9 KB

UserInput

Example Usage

import { UserInput } from "@apideck/unify/models/components";

let value: UserInput = {
  parentId: "54321",
  username: "masterofcoin",
  firstName: "Elon",
  lastName: "Musk",
  title: "CEO",
  division: "Europe",
  companyName: "SpaceX",
  employeeNumber: "123456-AB",
  description: "A description",
  image: "https://logo.clearbit.com/spacex.com?s=128",
  language: "EN",
  status: "active",
  password: "supersecretpassword",
  addresses: [
    {
      id: "123",
      type: "primary",
      string: "25 Spring Street, Blackburn, VIC 3130",
      name: "HQ US",
      line1: "Main street",
      line2: "apt #",
      line3: "Suite #",
      line4: "delivery instructions",
      line5: "Attention: Finance Dept",
      streetNumber: "25",
      city: "San Francisco",
      state: "CA",
      postalCode: "94104",
      country: "US",
      latitude: "40.759211",
      longitude: "-73.984638",
      county: "Santa Clara",
      contactName: "Elon Musk",
      salutation: "Mr",
      phoneNumber: "111-111-1111",
      fax: "122-111-1111",
      email: "elon@musk.com",
      website: "https://elonmusk.com",
      notes: "Address notes or delivery instructions.",
      rowVersion: "1-12345",
    },
  ],
  phoneNumbers: [
    {
      id: "12345",
      countryCode: "1",
      areaCode: "323",
      number: "111-111-1111",
      extension: "105",
      type: "primary",
    },
  ],
  emails: [],
  passThrough: [
    {
      serviceId: "<id>",
      extendPaths: [
        {
          path: "$.nested.property",
          value: {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000",
            },
          },
        },
      ],
    },
  ],
};

Fields

Field Type Required Description Example
parentId string ➖ The parent user id 54321
username string ➖ The username of the user masterofcoin
firstName string ➖ The first name of the person. Elon
lastName string ➖ The last name of the person. Musk
title string ➖ The job title of the person. CEO
division string ➖ The division the person is currently in. Usually a collection of departments or teams or regions. Europe
department string ➖ : warning: ** DEPRECATED **: Deprecated. Use department_id instead..

The department the person is currently in. Deprecated in favor of the dedicated department_id and department_name field.		 R&D
companyName string ➖ The name of the company. SpaceX
employeeNumber string ➖ An Employee Number, Employee ID or Employee Code, is a unique number that has been assigned to each individual staff member within a company. 123456-AB
description string ➖ A description of the object. A description
image string ➖ The URL of the user's avatar https://logo.clearbit.com/spacex.com?s=128
language string ➖ language code according to ISO 639-1. For the United States - EN EN
status string ➖ The status of the user active
password string ➖ The password of the user supersecretpassword
addresses components.Address[] ➖ N/A
phoneNumbers components.PhoneNumber[] ➖ N/A
emails components.Email[] ✔️ N/A
passThrough components.PassThroughBody[] ➖ The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.