@webitel/api-services
    Preparing search index...

    Function getContacts

    • Parameters

      • axiosInstance: AxiosInstance = axios

      Returns {
          createContact: (
              contactsInputContact: {
                  about?: string;
                  comments?: {
                      [key: number]: {
                          etag?: string;
                          format?: {
                              [key: number]: {
                                  bold?: { [key: string]: unknown };
                                  codeblock?: { language?: string };
                                  italic?: { [key: string]: unknown };
                                  length?: number;
                                  link?: { url?: string };
                                  monospace?: { [key: string]: unknown };
                                  offset?: number;
                                  strikethrough?: { [key: string]: unknown };
                                  underline?: { [key: string]: unknown };
                              };
                          };
                          text: string;
                      };
                  };
                  emails?: {
                      [key: number]: {
                          email: string;
                          etag?: string;
                          primary?: boolean;
                          type?: { id?: string; name?: string; type?: string };
                          verified?: boolean;
                      };
                  };
                  etag?: string;
                  groups?: {
                      [key: number]: {
                          etag: string;
                          group?: { id?: string; name?: string; type?: string };
                      };
                  };
                  imclients?: {
                      [key: number]: {
                          createdBy?: string;
                          externalUser?: string;
                          gatewayId?: string;
                          protocol?: string;
                          via?: string;
                      };
                  };
                  labels?: { [key: number]: { etag?: string; label?: string } };
                  languages?: {
                      [key: number]: { etag: string; primary?: boolean; tag?: string };
                  };
                  managers?: {
                      [key: number]: {
                          etag: string;
                          primary?: boolean;
                          user?: { id?: string; name?: string; type?: string };
                      };
                  };
                  name?: {
                      commonName?: string;
                      familyName?: string;
                      givenName?: string;
                      middleName?: string;
                      verified?: boolean;
                  };
                  phones?: {
                      [key: number]: {
                          etag?: string;
                          number: string;
                          primary?: boolean;
                          type?: { id?: string; name?: string; type?: string };
                          verified?: boolean;
                      };
                  };
                  timezones?: {
                      [key: number]: {
                          etag: string;
                          primary?: boolean;
                          timezone?: { id?: string; name?: string; type?: string };
                      };
                  };
                  variables?: {
                      [key: number]: { etag?: string; key: string; value?: unknown };
                  };
              },
              params?: CreateContactParams,
              options?: AxiosRequestConfig,
          ) => Promise<AxiosResponse<WebitelContactsContact, any, {}>>;
          deleteContact: (
              etag: string,
              params?: DeleteContactParams,
              options?: AxiosRequestConfig,
          ) => Promise<AxiosResponse<WebitelContactsContact, any, {}>>;
          locateContact: (
              etag: string,
              params?: LocateContactParams,
              options?: AxiosRequestConfig,
          ) => Promise<AxiosResponse<WebitelContactsContact, any, {}>>;
          searchContacts: (
              params?: SearchContactsParams,
              options?: AxiosRequestConfig,
          ) => Promise<AxiosResponse<ContactsContactList, any, {}>>;
          updateContact: (
              etag: string,
              updateContactBody: {
                  about?: string;
                  comments?: {
                      [key: number]: {
                          etag?: string;
                          format?: {
                              [key: number]: {
                                  bold?: { [key: string]: unknown };
                                  codeblock?: { language?: string };
                                  italic?: { [key: string]: unknown };
                                  length?: number;
                                  link?: { url?: string };
                                  monospace?: { [key: string]: unknown };
                                  offset?: number;
                                  strikethrough?: { [key: string]: unknown };
                                  underline?: { [key: string]: unknown };
                              };
                          };
                          text: string;
                      };
                  };
                  emails?: {
                      [key: number]: {
                          email: string;
                          etag?: string;
                          primary?: boolean;
                          type?: { id?: string; name?: string; type?: string };
                          verified?: boolean;
                      };
                  };
                  groups?: {
                      [key: number]: {
                          etag: string;
                          group?: { id?: string; name?: string; type?: string };
                      };
                  };
                  imclients?: {
                      [key: number]: {
                          createdBy?: string;
                          externalUser?: string;
                          gatewayId?: string;
                          protocol?: string;
                          via?: string;
                      };
                  };
                  labels?: { [key: number]: { etag?: string; label?: string } };
                  languages?: {
                      [key: number]: { etag: string; primary?: boolean; tag?: string };
                  };
                  managers?: {
                      [key: number]: {
                          etag: string;
                          primary?: boolean;
                          user?: { id?: string; name?: string; type?: string };
                      };
                  };
                  name?: {
                      commonName?: string;
                      familyName?: string;
                      givenName?: string;
                      middleName?: string;
                      verified?: boolean;
                  };
                  phones?: {
                      [key: number]: {
                          etag?: string;
                          number: string;
                          primary?: boolean;
                          type?: { id?: string; name?: string; type?: string };
                          verified?: boolean;
                      };
                  };
                  timezones?: {
                      [key: number]: {
                          etag: string;
                          primary?: boolean;
                          timezone?: { id?: string; name?: string; type?: string };
                      };
                  };
                  variables?: {
                      [key: number]: { etag?: string; key: string; value?: unknown };
                  };
              },
              params?: UpdateContactParams,
              options?: AxiosRequestConfig,
          ) => Promise<AxiosResponse<WebitelContactsContact, any, {}>>;
      }

      • createContact: (
            contactsInputContact: {
                about?: string;
                comments?: {
                    [key: number]: {
                        etag?: string;
                        format?: {
                            [key: number]: {
                                bold?: { [key: string]: unknown };
                                codeblock?: { language?: string };
                                italic?: { [key: string]: unknown };
                                length?: number;
                                link?: { url?: string };
                                monospace?: { [key: string]: unknown };
                                offset?: number;
                                strikethrough?: { [key: string]: unknown };
                                underline?: { [key: string]: unknown };
                            };
                        };
                        text: string;
                    };
                };
                emails?: {
                    [key: number]: {
                        email: string;
                        etag?: string;
                        primary?: boolean;
                        type?: { id?: string; name?: string; type?: string };
                        verified?: boolean;
                    };
                };
                etag?: string;
                groups?: {
                    [key: number]: {
                        etag: string;
                        group?: { id?: string; name?: string; type?: string };
                    };
                };
                imclients?: {
                    [key: number]: {
                        createdBy?: string;
                        externalUser?: string;
                        gatewayId?: string;
                        protocol?: string;
                        via?: string;
                    };
                };
                labels?: { [key: number]: { etag?: string; label?: string } };
                languages?: {
                    [key: number]: { etag: string; primary?: boolean; tag?: string };
                };
                managers?: {
                    [key: number]: {
                        etag: string;
                        primary?: boolean;
                        user?: { id?: string; name?: string; type?: string };
                    };
                };
                name?: {
                    commonName?: string;
                    familyName?: string;
                    givenName?: string;
                    middleName?: string;
                    verified?: boolean;
                };
                phones?: {
                    [key: number]: {
                        etag?: string;
                        number: string;
                        primary?: boolean;
                        type?: { id?: string; name?: string; type?: string };
                        verified?: boolean;
                    };
                };
                timezones?: {
                    [key: number]: {
                        etag: string;
                        primary?: boolean;
                        timezone?: { id?: string; name?: string; type?: string };
                    };
                };
                variables?: {
                    [key: number]: { etag?: string; key: string; value?: unknown };
                };
            },
            params?: CreateContactParams,
            options?: AxiosRequestConfig,
        ) => Promise<AxiosResponse<WebitelContactsContact, any, {}>>
      • deleteContact: (
            etag: string,
            params?: DeleteContactParams,
            options?: AxiosRequestConfig,
        ) => Promise<AxiosResponse<WebitelContactsContact, any, {}>>
      • locateContact: (
            etag: string,
            params?: LocateContactParams,
            options?: AxiosRequestConfig,
        ) => Promise<AxiosResponse<WebitelContactsContact, any, {}>>
      • searchContacts: (
            params?: SearchContactsParams,
            options?: AxiosRequestConfig,
        ) => Promise<AxiosResponse<ContactsContactList, any, {}>>
        Field Type
        ----------- READ-ONLY -----------
        id int64
        ver int32
        etag string
        ---------- OPERATIONAL ----------
        created_at int64(epoch:milli)
        created_by lookup(user)
        updated_at int64(epoch:milli)
        updated_by lookup(user)
        ---------- ATTRIBUTES -----------
        name name!
        about string
        labels list[label!]
        emails list[email!]
        photos list[photo!]
        phones list[phone!]
        managers list[manager!]
        comments list[comment!]
        addresses list[address!]
        languages list[language!]
        timezones list[timezone!]
        variables list[variable!]
        imclients list[imClient!]
      • updateContact: (
            etag: string,
            updateContactBody: {
                about?: string;
                comments?: {
                    [key: number]: {
                        etag?: string;
                        format?: {
                            [key: number]: {
                                bold?: { [key: string]: unknown };
                                codeblock?: { language?: string };
                                italic?: { [key: string]: unknown };
                                length?: number;
                                link?: { url?: string };
                                monospace?: { [key: string]: unknown };
                                offset?: number;
                                strikethrough?: { [key: string]: unknown };
                                underline?: { [key: string]: unknown };
                            };
                        };
                        text: string;
                    };
                };
                emails?: {
                    [key: number]: {
                        email: string;
                        etag?: string;
                        primary?: boolean;
                        type?: { id?: string; name?: string; type?: string };
                        verified?: boolean;
                    };
                };
                groups?: {
                    [key: number]: {
                        etag: string;
                        group?: { id?: string; name?: string; type?: string };
                    };
                };
                imclients?: {
                    [key: number]: {
                        createdBy?: string;
                        externalUser?: string;
                        gatewayId?: string;
                        protocol?: string;
                        via?: string;
                    };
                };
                labels?: { [key: number]: { etag?: string; label?: string } };
                languages?: {
                    [key: number]: { etag: string; primary?: boolean; tag?: string };
                };
                managers?: {
                    [key: number]: {
                        etag: string;
                        primary?: boolean;
                        user?: { id?: string; name?: string; type?: string };
                    };
                };
                name?: {
                    commonName?: string;
                    familyName?: string;
                    givenName?: string;
                    middleName?: string;
                    verified?: boolean;
                };
                phones?: {
                    [key: number]: {
                        etag?: string;
                        number: string;
                        primary?: boolean;
                        type?: { id?: string; name?: string; type?: string };
                        verified?: boolean;
                    };
                };
                timezones?: {
                    [key: number]: {
                        etag: string;
                        primary?: boolean;
                        timezone?: { id?: string; name?: string; type?: string };
                    };
                };
                variables?: {
                    [key: number]: { etag?: string; key: string; value?: unknown };
                };
            },
            params?: UpdateContactParams,
            options?: AxiosRequestConfig,
        ) => Promise<AxiosResponse<WebitelContactsContact, any, {}>>