Skip to main content

Function: companyService()

companyService(client): object

Defined in: service/CompanyService.ts:72

Parameters​

client​

GraphQLClient

Returns​

createCompany()​

createCompany(variables): Promise<Company>

Creates a new company *

Parameters​

variables​

CompanyCreateVariables

    • input: CreateCompanyInput - Company creation input
    • contactPAConfigInput: ContactPurchaseAuthorizationConfigSearchInput - Contact purchase authorization config search input
    • companyAttributesInput: AttributeResultSearchInput - Company attributes search input
    • contactSearchArguments: ContactSearchArguments - Contact search arguments

Returns​

Promise<Company>

Promise<Company> The created company

getCompanies()​

getCompanies(variables): Promise&lt;CompaniesResponse>

Retrieves companies with search criteria *

Parameters​

variables​

CompanySearchVariables

    • input: CompanySearchInput - Company search input
    • contactPAConfigInput: ContactPurchaseAuthorizationConfigSearchInput - Contact purchase authorization config search input
    • companyAttributesInput: AttributeResultSearchInput - Company attributes search input
    • contactSearchArguments: ContactSearchArguments - Contact search arguments

Returns​

Promise&lt;CompaniesResponse>

Promise<CompaniesResponse> Companies response

getCompany()​

getCompany(variables): Promise&lt;Company>

Retrieves a specific company *

Parameters​

variables​

CompanyVariables

    • id: number - Company ID
    • contactPAConfigInput: ContactPurchaseAuthorizationConfigSearchInput - Contact purchase authorization config search input
    • companyAttributesInput: AttributeResultSearchInput - Company attributes search input
    • contactSearchArguments: ContactSearchArguments - Contact search arguments

Returns​

Promise&lt;Company>

Promise<Company> Company data

importCompaniesCsv()​

importCompaniesCsv(input): Promise&lt;CsvImportResponse>

Imports companies from CSV file *

Parameters​

input​

CompanyCsvInput

Company CSV import input *

Returns​

Promise&lt;CsvImportResponse>

Promise<Company[]> Array of imported companies

updateCompany()​

updateCompany(variables): Promise&lt;Company>

Updates an existing company *

Parameters​

variables​

CompanyUpdateVariables

    • input: UpdateCompanyInput - Company update input
    • contactPAConfigInput: ContactPurchaseAuthorizationConfigSearchInput - Contact purchase authorization config search input
    • companyAttributesInput: AttributeResultSearchInput - Company attributes search input
    • contactSearchArguments: ContactSearchArguments - Contact search arguments

Returns​

Promise&lt;Company>

Promise<Company> The updated company