@cfxlabsinc/b2b-services
    Preparing search index...

    Class AttioClient

    https://docs.attio.com/

    Index
    constructor
    createTransactionRecord queryCompanies updateCustomerTermsAcceptance

    • Parameters

      • values: {
            customerAttioId: string;
            feeCurrency?: string;
            id: string;
            method: string;
            sourceAmount: number;
            sourceCurrency: string;
            targetAmount: number;
            targetCurrency: string;
            totalFees: number;
            type: "Deposit" | "Withdrawal";
        }

      Returns Promise<
          {
              data: {
                  created_at: string;
                  id: { object_id: string; record_id: string; workspace_id: string };
                  values: {
                      [key: string]: (
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "actor-reference";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              referenced_actor_id: string
                              | null;
                              referenced_actor_type:
                                  | "api-token"
                                  | "workspace-member"
                                  | "system"
                                  | "app";
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "checkbox";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              value: boolean;
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "currency";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              currency_code?: | "AUD"
                              | "BRL"
                              | "BEL"
                              | "CAD"
                              | "CLP"
                              | "CNY"
                              | "COP"
                              | "CZK"
                              | "DKK"
                              | "EUR"
                              | "HKD"
                              | "ISK"
                              | "INR"
                              | "ILS"
                              | "JPY"
                              | "KRW"
                              | "MYR"
                              | "MXN"
                              | "NTD"
                              | "NZD"
                              | "NGN"
                              | "NOK"
                              | "XPF"
                              | "PEN"
                              | "PHP"
                              | "PLN"
                              | "GBP"
                              | "SAR"
                              | "SGD"
                              | "ZAR"
                              | "SEK"
                              | "CHF"
                              | "AED"
                              | "USD"
                              | null;
                              currency_value: number;
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "date";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              value: string;
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "domain";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              domain: string;
                              root_domain: string;
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "email-address";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              email_address: string;
                              email_domain: string;
                              email_local_specifier: string;
                              email_root_domain: string;
                              original_email_address: string;
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "record-reference";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              target_object: string;
                              target_record_id: string;
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "interaction";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              interacted_at: string;
                              interaction_type: | "email"
                              | "calendar-event"
                              | "call"
                              | "chat-thread"
                              | "in-person-meeting"
                              | "meeting";
                              owner_actor: {
                                  id?: string
                                  | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "location";
                              country_code:
                                  | "NO"
                                  | "AF"
                                  | "AX"
                                  | "AL"
                                  | "DZ"
                                  | "AS"
                                  | "AD"
                                  | "AO"
                                  | "AI"
                                  | "AQ"
                                  | "AG"
                                  | "AR"
                                  | "AM"
                                  | "AW"
                                  | "AU"
                                  | "AT"
                                  | "AZ"
                                  | "BS"
                                  | "BH"
                                  | "BD"
                                  | "BB"
                                  | "BY"
                                  | "BE"
                                  | "BZ"
                                  | "BJ"
                                  | "BM"
                                  | "BT"
                                  | "BO"
                                  | "BA"
                                  | "BW"
                                  | "BV"
                                  | "BR"
                                  | "IO"
                                  | "BN"
                                  | "BG"
                                  | "BF"
                                  | "BI"
                                  | "KH"
                                  | "CM"
                                  | "CA"
                                  | "CV"
                                  | "KY"
                                  | "CF"
                                  | "TD"
                                  | "CL"
                                  | "CN"
                                  | "CX"
                                  | "CC"
                                  | "CO"
                                  | "KM"
                                  | "CG"
                                  | "CD"
                                  | "CK"
                                  | "CR"
                                  | "CI"
                                  | "HR"
                                  | "CU"
                                  | "CW"
                                  | "CY"
                                  | "CZ"
                                  | "DK"
                                  | "DJ"
                                  | "DM"
                                  | "DO"
                                  | "EC"
                                  | "EG"
                                  | "SV"
                                  | "GQ"
                                  | "ER"
                                  | "EE"
                                  | "ET"
                                  | "FK"
                                  | "FO"
                                  | "FJ"
                                  | "FI"
                                  | "FR"
                                  | "GF"
                                  | "PF"
                                  | "TF"
                                  | "GA"
                                  | "GM"
                                  | "GE"
                                  | "DE"
                                  | "GH"
                                  | "GI"
                                  | "GR"
                                  | "GL"
                                  | "GD"
                                  | "GP"
                                  | "GU"
                                  | "GT"
                                  | "GG"
                                  | "GN"
                                  | "GW"
                                  | "GY"
                                  | "HT"
                                  | "HM"
                                  | "VA"
                                  | "HN"
                                  | "HK"
                                  | "HU"
                                  | "IS"
                                  | "IN"
                                  | "ID"
                                  | "IR"
                                  | "IQ"
                                  | "IE"
                                  | "IM"
                                  | "IL"
                                  | "IT"
                                  | "JM"
                                  | "JP"
                                  | "JE"
                                  | "JO"
                                  | "KZ"
                                  | "KE"
                                  | "KI"
                                  | "KR"
                                  | "KW"
                                  | "KG"
                                  | "LA"
                                  | "LV"
                                  | "LB"
                                  | "LS"
                                  | "LR"
                                  | "LY"
                                  | "LI"
                                  | "LT"
                                  | "LU"
                                  | "MO"
                                  | "MK"
                                  | "MG"
                                  | "MW"
                                  | "MY"
                                  | "MV"
                                  | "ML"
                                  | "MT"
                                  | "MH"
                                  | "MQ"
                                  | "MR"
                                  | "MU"
                                  | "YT"
                                  | "MX"
                                  | "FM"
                                  | "MD"
                                  | "MC"
                                  | "MN"
                                  | "ME"
                                  | "MS"
                                  | "MA"
                                  | "MZ"
                                  | "MM"
                                  | "NA"
                                  | "NR"
                                  | "NP"
                                  | "NL"
                                  | "AN"
                                  | "NC"
                                  | "NZ"
                                  | "NI"
                                  | "NE"
                                  | "NG"
                                  | "NU"
                                  | "NF"
                                  | "MP"
                                  | "OM"
                                  | "PK"
                                  | "PW"
                                  | "PS"
                                  | "PA"
                                  | "PG"
                                  | "PY"
                                  | "PE"
                                  | "PH"
                                  | "PN"
                                  | "PL"
                                  | "PT"
                                  | "PR"
                                  | "QA"
                                  | "RE"
                                  | "RO"
                                  | "RU"
                                  | "RW"
                                  | "BL"
                                  | "SH"
                                  | "KN"
                                  | "LC"
                                  | "MF"
                                  | "PM"
                                  | "VC"
                                  | "WS"
                                  | "SM"
                                  | "ST"
                                  | "SA"
                                  | "SN"
                                  | "SS"
                                  | "RS"
                                  | "SC"
                                  | "SL"
                                  | "SG"
                                  | "SK"
                                  | "SI"
                                  | "SB"
                                  | "SO"
                                  | "ZA"
                                  | "GS"
                                  | "ES"
                                  | "LK"
                                  | "SD"
                                  | "SR"
                                  | "SJ"
                                  | "SZ"
                                  | "SE"
                                  | "CH"
                                  | "SY"
                                  | "TW"
                                  | "TJ"
                                  | "TZ"
                                  | "TH"
                                  | "TL"
                                  | "TG"
                                  | "TK"
                                  | "TO"
                                  | "TT"
                                  | "TN"
                                  | "TR"
                                  | "TM"
                                  | "TC"
                                  | "TV"
                                  | "UG"
                                  | "UA"
                                  | "AE"
                                  | "GB"
                                  | "US"
                                  | "UM"
                                  | "UY"
                                  | "UZ"
                                  | "VU"
                                  | "VE"
                                  | "VN"
                                  | "VG"
                                  | "VI"
                                  | "WF"
                                  | "EH"
                                  | "YE"
                                  | "ZM"
                                  | "ZW"
                                  | "BQ"
                                  | "KP"
                                  | "SX"
                                  | null;
                              created_by_actor: {
                                  id?: string
                                  | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              latitude: string
                              | null;
                              line_1: string | null;
                              line_2: string | null;
                              line_3: string | null;
                              line_4: string | null;
                              locality: string | null;
                              longitude: string | null;
                              postcode: string | null;
                              region: string | null;
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "number";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              value: number;
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "personal-name";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              first_name: string;
                              full_name: string;
                              last_name: string;
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "phone-number";
                              country_code:
                                  | "NO"
                                  | "AF"
                                  | "AX"
                                  | "AL"
                                  | "DZ"
                                  | "AS"
                                  | "AD"
                                  | "AO"
                                  | "AI"
                                  | "AQ"
                                  | "AG"
                                  | "AR"
                                  | "AM"
                                  | "AW"
                                  | "AU"
                                  | "AT"
                                  | "AZ"
                                  | "BS"
                                  | "BH"
                                  | "BD"
                                  | "BB"
                                  | "BY"
                                  | "BE"
                                  | "BZ"
                                  | "BJ"
                                  | "BM"
                                  | "BT"
                                  | "BO"
                                  | "BA"
                                  | "BW"
                                  | "BV"
                                  | "BR"
                                  | "IO"
                                  | "BN"
                                  | "BG"
                                  | "BF"
                                  | "BI"
                                  | "KH"
                                  | "CM"
                                  | "CA"
                                  | "CV"
                                  | "KY"
                                  | "CF"
                                  | "TD"
                                  | "CL"
                                  | "CN"
                                  | "CX"
                                  | "CC"
                                  | "CO"
                                  | "KM"
                                  | "CG"
                                  | "CD"
                                  | "CK"
                                  | "CR"
                                  | "CI"
                                  | "HR"
                                  | "CU"
                                  | "CW"
                                  | "CY"
                                  | "CZ"
                                  | "DK"
                                  | "DJ"
                                  | "DM"
                                  | "DO"
                                  | "EC"
                                  | "EG"
                                  | "SV"
                                  | "GQ"
                                  | "ER"
                                  | "EE"
                                  | "ET"
                                  | "FK"
                                  | "FO"
                                  | "FJ"
                                  | "FI"
                                  | "FR"
                                  | "GF"
                                  | "PF"
                                  | "TF"
                                  | "GA"
                                  | "GM"
                                  | "GE"
                                  | "DE"
                                  | "GH"
                                  | "GI"
                                  | "GR"
                                  | "GL"
                                  | "GD"
                                  | "GP"
                                  | "GU"
                                  | "GT"
                                  | "GG"
                                  | "GN"
                                  | "GW"
                                  | "GY"
                                  | "HT"
                                  | "HM"
                                  | "VA"
                                  | "HN"
                                  | "HK"
                                  | "HU"
                                  | "IS"
                                  | "IN"
                                  | "ID"
                                  | "IR"
                                  | "IQ"
                                  | "IE"
                                  | "IM"
                                  | "IL"
                                  | "IT"
                                  | "JM"
                                  | "JP"
                                  | "JE"
                                  | "JO"
                                  | "KZ"
                                  | "KE"
                                  | "KI"
                                  | "KR"
                                  | "KW"
                                  | "KG"
                                  | "LA"
                                  | "LV"
                                  | "LB"
                                  | "LS"
                                  | "LR"
                                  | "LY"
                                  | "LI"
                                  | "LT"
                                  | "LU"
                                  | "MO"
                                  | "MK"
                                  | "MG"
                                  | "MW"
                                  | "MY"
                                  | "MV"
                                  | "ML"
                                  | "MT"
                                  | "MH"
                                  | "MQ"
                                  | "MR"
                                  | "MU"
                                  | "YT"
                                  | "MX"
                                  | "FM"
                                  | "MD"
                                  | "MC"
                                  | "MN"
                                  | "ME"
                                  | "MS"
                                  | "MA"
                                  | "MZ"
                                  | "MM"
                                  | "NA"
                                  | "NR"
                                  | "NP"
                                  | "NL"
                                  | "AN"
                                  | "NC"
                                  | "NZ"
                                  | "NI"
                                  | "NE"
                                  | "NG"
                                  | "NU"
                                  | "NF"
                                  | "MP"
                                  | "OM"
                                  | "PK"
                                  | "PW"
                                  | "PS"
                                  | "PA"
                                  | "PG"
                                  | "PY"
                                  | "PE"
                                  | "PH"
                                  | "PN"
                                  | "PL"
                                  | "PT"
                                  | "PR"
                                  | "QA"
                                  | "RE"
                                  | "RO"
                                  | "RU"
                                  | "RW"
                                  | "BL"
                                  | "SH"
                                  | "KN"
                                  | "LC"
                                  | "MF"
                                  | "PM"
                                  | "VC"
                                  | "WS"
                                  | "SM"
                                  | "ST"
                                  | "SA"
                                  | "SN"
                                  | "SS"
                                  | "RS"
                                  | "SC"
                                  | "SL"
                                  | "SG"
                                  | "SK"
                                  | "SI"
                                  | "SB"
                                  | "SO"
                                  | "ZA"
                                  | "GS"
                                  | "ES"
                                  | "LK"
                                  | "SD"
                                  | "SR"
                                  | "SJ"
                                  | "SZ"
                                  | "SE"
                                  | "CH"
                                  | "SY"
                                  | "TW"
                                  | "TJ"
                                  | "TZ"
                                  | "TH"
                                  | "TL"
                                  | "TG"
                                  | "TK"
                                  | "TO"
                                  | "TT"
                                  | "TN"
                                  | "TR"
                                  | "TM"
                                  | "TC"
                                  | "TV"
                                  | "UG"
                                  | "UA"
                                  | "AE"
                                  | "GB"
                                  | "US"
                                  | "UM"
                                  | "UY"
                                  | "UZ"
                                  | "VU"
                                  | "VE"
                                  | "VN"
                                  | "VG"
                                  | "VI"
                                  | "WF"
                                  | "EH"
                                  | "YE"
                                  | "ZM"
                                  | "ZW"
                                  | "BQ"
                                  | "KP"
                                  | "SX";
                              created_by_actor: {
                                  id?: string
                                  | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              original_phone_number: string;
                              phone_number: string;
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "status";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              status: {
                                  celebration_enabled: boolean;
                                  id: {
                                      attribute_id: string;
                                      object_id: string;
                                      status_id: string;
                                      workspace_id: string;
                                  };
                                  is_archived: boolean;
                                  target_time_in_status: string
                                  | null;
                                  title: string;
                              };
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "rating";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              value: number;
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "select";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              option: {
                                  id: {
                                      attribute_id: string;
                                      object_id: string;
                                      option_id: string;
                                      workspace_id: string;
                                  };
                                  is_archived: boolean;
                                  title: string;
                              };
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "text";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              value: string;
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "timestamp";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              value: string;
                          }
                      )[];
                  };
                  web_url: string;
              };
          },
      >

      https://docs.attio.com/reference/post_v2-objects-object-records

    • Search company records for an operator-facing selector. Matches name (case-insensitive contains) when query is set; otherwise returns the first page ordered by name. Returns just the fields a selector renders, plus the AiPrise profile the CFX workspace records on the company.

      Parameters

      • __namedParameters: { limit?: number; offset?: number; query?: string }

      Returns Promise<
          {
              aipriseProfileId?: string;
              domain?: string;
              name: string;
              recordId: string;
          }[],
      >

      https://docs.attio.com/reference/post_v2-objects-object-records-query

    • Parameters

      • __namedParameters: { acceptedTermsOfService: boolean; customerAttioId: string }

      Returns Promise<
          {
              data: {
                  created_at: string;
                  id: { object_id: string; record_id: string; workspace_id: string };
                  values: {
                      [key: string]: (
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "actor-reference";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              referenced_actor_id: string
                              | null;
                              referenced_actor_type:
                                  | "api-token"
                                  | "workspace-member"
                                  | "system"
                                  | "app";
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "checkbox";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              value: boolean;
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "currency";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              currency_code?: | "AUD"
                              | "BRL"
                              | "BEL"
                              | "CAD"
                              | "CLP"
                              | "CNY"
                              | "COP"
                              | "CZK"
                              | "DKK"
                              | "EUR"
                              | "HKD"
                              | "ISK"
                              | "INR"
                              | "ILS"
                              | "JPY"
                              | "KRW"
                              | "MYR"
                              | "MXN"
                              | "NTD"
                              | "NZD"
                              | "NGN"
                              | "NOK"
                              | "XPF"
                              | "PEN"
                              | "PHP"
                              | "PLN"
                              | "GBP"
                              | "SAR"
                              | "SGD"
                              | "ZAR"
                              | "SEK"
                              | "CHF"
                              | "AED"
                              | "USD"
                              | null;
                              currency_value: number;
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "date";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              value: string;
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "domain";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              domain: string;
                              root_domain: string;
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "email-address";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              email_address: string;
                              email_domain: string;
                              email_local_specifier: string;
                              email_root_domain: string;
                              original_email_address: string;
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "record-reference";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              target_object: string;
                              target_record_id: string;
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "interaction";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              interacted_at: string;
                              interaction_type: | "email"
                              | "calendar-event"
                              | "call"
                              | "chat-thread"
                              | "in-person-meeting"
                              | "meeting";
                              owner_actor: {
                                  id?: string
                                  | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "location";
                              country_code:
                                  | "NO"
                                  | "AF"
                                  | "AX"
                                  | "AL"
                                  | "DZ"
                                  | "AS"
                                  | "AD"
                                  | "AO"
                                  | "AI"
                                  | "AQ"
                                  | "AG"
                                  | "AR"
                                  | "AM"
                                  | "AW"
                                  | "AU"
                                  | "AT"
                                  | "AZ"
                                  | "BS"
                                  | "BH"
                                  | "BD"
                                  | "BB"
                                  | "BY"
                                  | "BE"
                                  | "BZ"
                                  | "BJ"
                                  | "BM"
                                  | "BT"
                                  | "BO"
                                  | "BA"
                                  | "BW"
                                  | "BV"
                                  | "BR"
                                  | "IO"
                                  | "BN"
                                  | "BG"
                                  | "BF"
                                  | "BI"
                                  | "KH"
                                  | "CM"
                                  | "CA"
                                  | "CV"
                                  | "KY"
                                  | "CF"
                                  | "TD"
                                  | "CL"
                                  | "CN"
                                  | "CX"
                                  | "CC"
                                  | "CO"
                                  | "KM"
                                  | "CG"
                                  | "CD"
                                  | "CK"
                                  | "CR"
                                  | "CI"
                                  | "HR"
                                  | "CU"
                                  | "CW"
                                  | "CY"
                                  | "CZ"
                                  | "DK"
                                  | "DJ"
                                  | "DM"
                                  | "DO"
                                  | "EC"
                                  | "EG"
                                  | "SV"
                                  | "GQ"
                                  | "ER"
                                  | "EE"
                                  | "ET"
                                  | "FK"
                                  | "FO"
                                  | "FJ"
                                  | "FI"
                                  | "FR"
                                  | "GF"
                                  | "PF"
                                  | "TF"
                                  | "GA"
                                  | "GM"
                                  | "GE"
                                  | "DE"
                                  | "GH"
                                  | "GI"
                                  | "GR"
                                  | "GL"
                                  | "GD"
                                  | "GP"
                                  | "GU"
                                  | "GT"
                                  | "GG"
                                  | "GN"
                                  | "GW"
                                  | "GY"
                                  | "HT"
                                  | "HM"
                                  | "VA"
                                  | "HN"
                                  | "HK"
                                  | "HU"
                                  | "IS"
                                  | "IN"
                                  | "ID"
                                  | "IR"
                                  | "IQ"
                                  | "IE"
                                  | "IM"
                                  | "IL"
                                  | "IT"
                                  | "JM"
                                  | "JP"
                                  | "JE"
                                  | "JO"
                                  | "KZ"
                                  | "KE"
                                  | "KI"
                                  | "KR"
                                  | "KW"
                                  | "KG"
                                  | "LA"
                                  | "LV"
                                  | "LB"
                                  | "LS"
                                  | "LR"
                                  | "LY"
                                  | "LI"
                                  | "LT"
                                  | "LU"
                                  | "MO"
                                  | "MK"
                                  | "MG"
                                  | "MW"
                                  | "MY"
                                  | "MV"
                                  | "ML"
                                  | "MT"
                                  | "MH"
                                  | "MQ"
                                  | "MR"
                                  | "MU"
                                  | "YT"
                                  | "MX"
                                  | "FM"
                                  | "MD"
                                  | "MC"
                                  | "MN"
                                  | "ME"
                                  | "MS"
                                  | "MA"
                                  | "MZ"
                                  | "MM"
                                  | "NA"
                                  | "NR"
                                  | "NP"
                                  | "NL"
                                  | "AN"
                                  | "NC"
                                  | "NZ"
                                  | "NI"
                                  | "NE"
                                  | "NG"
                                  | "NU"
                                  | "NF"
                                  | "MP"
                                  | "OM"
                                  | "PK"
                                  | "PW"
                                  | "PS"
                                  | "PA"
                                  | "PG"
                                  | "PY"
                                  | "PE"
                                  | "PH"
                                  | "PN"
                                  | "PL"
                                  | "PT"
                                  | "PR"
                                  | "QA"
                                  | "RE"
                                  | "RO"
                                  | "RU"
                                  | "RW"
                                  | "BL"
                                  | "SH"
                                  | "KN"
                                  | "LC"
                                  | "MF"
                                  | "PM"
                                  | "VC"
                                  | "WS"
                                  | "SM"
                                  | "ST"
                                  | "SA"
                                  | "SN"
                                  | "SS"
                                  | "RS"
                                  | "SC"
                                  | "SL"
                                  | "SG"
                                  | "SK"
                                  | "SI"
                                  | "SB"
                                  | "SO"
                                  | "ZA"
                                  | "GS"
                                  | "ES"
                                  | "LK"
                                  | "SD"
                                  | "SR"
                                  | "SJ"
                                  | "SZ"
                                  | "SE"
                                  | "CH"
                                  | "SY"
                                  | "TW"
                                  | "TJ"
                                  | "TZ"
                                  | "TH"
                                  | "TL"
                                  | "TG"
                                  | "TK"
                                  | "TO"
                                  | "TT"
                                  | "TN"
                                  | "TR"
                                  | "TM"
                                  | "TC"
                                  | "TV"
                                  | "UG"
                                  | "UA"
                                  | "AE"
                                  | "GB"
                                  | "US"
                                  | "UM"
                                  | "UY"
                                  | "UZ"
                                  | "VU"
                                  | "VE"
                                  | "VN"
                                  | "VG"
                                  | "VI"
                                  | "WF"
                                  | "EH"
                                  | "YE"
                                  | "ZM"
                                  | "ZW"
                                  | "BQ"
                                  | "KP"
                                  | "SX"
                                  | null;
                              created_by_actor: {
                                  id?: string
                                  | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              latitude: string
                              | null;
                              line_1: string | null;
                              line_2: string | null;
                              line_3: string | null;
                              line_4: string | null;
                              locality: string | null;
                              longitude: string | null;
                              postcode: string | null;
                              region: string | null;
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "number";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              value: number;
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "personal-name";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              first_name: string;
                              full_name: string;
                              last_name: string;
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "phone-number";
                              country_code:
                                  | "NO"
                                  | "AF"
                                  | "AX"
                                  | "AL"
                                  | "DZ"
                                  | "AS"
                                  | "AD"
                                  | "AO"
                                  | "AI"
                                  | "AQ"
                                  | "AG"
                                  | "AR"
                                  | "AM"
                                  | "AW"
                                  | "AU"
                                  | "AT"
                                  | "AZ"
                                  | "BS"
                                  | "BH"
                                  | "BD"
                                  | "BB"
                                  | "BY"
                                  | "BE"
                                  | "BZ"
                                  | "BJ"
                                  | "BM"
                                  | "BT"
                                  | "BO"
                                  | "BA"
                                  | "BW"
                                  | "BV"
                                  | "BR"
                                  | "IO"
                                  | "BN"
                                  | "BG"
                                  | "BF"
                                  | "BI"
                                  | "KH"
                                  | "CM"
                                  | "CA"
                                  | "CV"
                                  | "KY"
                                  | "CF"
                                  | "TD"
                                  | "CL"
                                  | "CN"
                                  | "CX"
                                  | "CC"
                                  | "CO"
                                  | "KM"
                                  | "CG"
                                  | "CD"
                                  | "CK"
                                  | "CR"
                                  | "CI"
                                  | "HR"
                                  | "CU"
                                  | "CW"
                                  | "CY"
                                  | "CZ"
                                  | "DK"
                                  | "DJ"
                                  | "DM"
                                  | "DO"
                                  | "EC"
                                  | "EG"
                                  | "SV"
                                  | "GQ"
                                  | "ER"
                                  | "EE"
                                  | "ET"
                                  | "FK"
                                  | "FO"
                                  | "FJ"
                                  | "FI"
                                  | "FR"
                                  | "GF"
                                  | "PF"
                                  | "TF"
                                  | "GA"
                                  | "GM"
                                  | "GE"
                                  | "DE"
                                  | "GH"
                                  | "GI"
                                  | "GR"
                                  | "GL"
                                  | "GD"
                                  | "GP"
                                  | "GU"
                                  | "GT"
                                  | "GG"
                                  | "GN"
                                  | "GW"
                                  | "GY"
                                  | "HT"
                                  | "HM"
                                  | "VA"
                                  | "HN"
                                  | "HK"
                                  | "HU"
                                  | "IS"
                                  | "IN"
                                  | "ID"
                                  | "IR"
                                  | "IQ"
                                  | "IE"
                                  | "IM"
                                  | "IL"
                                  | "IT"
                                  | "JM"
                                  | "JP"
                                  | "JE"
                                  | "JO"
                                  | "KZ"
                                  | "KE"
                                  | "KI"
                                  | "KR"
                                  | "KW"
                                  | "KG"
                                  | "LA"
                                  | "LV"
                                  | "LB"
                                  | "LS"
                                  | "LR"
                                  | "LY"
                                  | "LI"
                                  | "LT"
                                  | "LU"
                                  | "MO"
                                  | "MK"
                                  | "MG"
                                  | "MW"
                                  | "MY"
                                  | "MV"
                                  | "ML"
                                  | "MT"
                                  | "MH"
                                  | "MQ"
                                  | "MR"
                                  | "MU"
                                  | "YT"
                                  | "MX"
                                  | "FM"
                                  | "MD"
                                  | "MC"
                                  | "MN"
                                  | "ME"
                                  | "MS"
                                  | "MA"
                                  | "MZ"
                                  | "MM"
                                  | "NA"
                                  | "NR"
                                  | "NP"
                                  | "NL"
                                  | "AN"
                                  | "NC"
                                  | "NZ"
                                  | "NI"
                                  | "NE"
                                  | "NG"
                                  | "NU"
                                  | "NF"
                                  | "MP"
                                  | "OM"
                                  | "PK"
                                  | "PW"
                                  | "PS"
                                  | "PA"
                                  | "PG"
                                  | "PY"
                                  | "PE"
                                  | "PH"
                                  | "PN"
                                  | "PL"
                                  | "PT"
                                  | "PR"
                                  | "QA"
                                  | "RE"
                                  | "RO"
                                  | "RU"
                                  | "RW"
                                  | "BL"
                                  | "SH"
                                  | "KN"
                                  | "LC"
                                  | "MF"
                                  | "PM"
                                  | "VC"
                                  | "WS"
                                  | "SM"
                                  | "ST"
                                  | "SA"
                                  | "SN"
                                  | "SS"
                                  | "RS"
                                  | "SC"
                                  | "SL"
                                  | "SG"
                                  | "SK"
                                  | "SI"
                                  | "SB"
                                  | "SO"
                                  | "ZA"
                                  | "GS"
                                  | "ES"
                                  | "LK"
                                  | "SD"
                                  | "SR"
                                  | "SJ"
                                  | "SZ"
                                  | "SE"
                                  | "CH"
                                  | "SY"
                                  | "TW"
                                  | "TJ"
                                  | "TZ"
                                  | "TH"
                                  | "TL"
                                  | "TG"
                                  | "TK"
                                  | "TO"
                                  | "TT"
                                  | "TN"
                                  | "TR"
                                  | "TM"
                                  | "TC"
                                  | "TV"
                                  | "UG"
                                  | "UA"
                                  | "AE"
                                  | "GB"
                                  | "US"
                                  | "UM"
                                  | "UY"
                                  | "UZ"
                                  | "VU"
                                  | "VE"
                                  | "VN"
                                  | "VG"
                                  | "VI"
                                  | "WF"
                                  | "EH"
                                  | "YE"
                                  | "ZM"
                                  | "ZW"
                                  | "BQ"
                                  | "KP"
                                  | "SX";
                              created_by_actor: {
                                  id?: string
                                  | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              original_phone_number: string;
                              phone_number: string;
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "status";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              status: {
                                  celebration_enabled: boolean;
                                  id: {
                                      attribute_id: string;
                                      object_id: string;
                                      status_id: string;
                                      workspace_id: string;
                                  };
                                  is_archived: boolean;
                                  target_time_in_status: string
                                  | null;
                                  title: string;
                              };
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "rating";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              value: number;
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "select";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              option: {
                                  id: {
                                      attribute_id: string;
                                      object_id: string;
                                      option_id: string;
                                      workspace_id: string;
                                  };
                                  is_archived: boolean;
                                  title: string;
                              };
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "text";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              value: string;
                          }
                          | {
                              active_from: string;
                              active_until: string
                              | null;
                              attribute_type: "timestamp";
                              created_by_actor: {
                                  id?: string | null;
                                  type?: "api-token" | "workspace-member" | "system" | "app" | null;
                              };
                              value: string;
                          }
                      )[];
                  };
                  web_url: string;
              };
          },
      >

    Settings
    Member Visibility

    On This Page
    Constructors
    Methods