Class GACompanies

Hierarchy

GlobalApi
- GACompanies

Index

Constructors

constructor

Properties

config

Methods

Constructors

constructor

new GACompanies(instanceConfig?: IGlobalApiSdkConfig): GACompanies

Inherited from GlobalApi.constructor
- Defined in src/GlobalAPI.ts:39
Parameters
- Optional instanceConfig: IGlobalApiSdkConfig
Returns GACompanies

Properties

Static config

config: IGlobalApiSdkConfig

Methods

Protected makeApiCall

makeApiCall(action: string, data?: indexedObject): IGlobalApiCallConfig

Inherited from GlobalApi.makeApiCall
- Defined in src/GlobalAPI.ts:51
Parameters
- action: string
- Optional data: indexedObject
Returns IGlobalApiCallConfig

Static createCompanyTemplate

createCompanyTemplate(payload: ICompanyJobTemplatePayload, instanceConfig?: IGlobalApiSdkConfig): Promise<IApiResponseObj<{ message: string; template: ITemplate }>>

- Defined in src/GACompanies.ts:40
Parameters
- payload: ICompanyJobTemplatePayload
- Optional instanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<{ message: string; template: ITemplate }>>

Static createCompanyTemplateBulk

createCompanyTemplateBulk(payload: ICompanyJobTemplatePayload[], instanceConfig?: IGlobalApiSdkConfig): Promise<IApiResponseObj<{ message: string; templates: ITemplate[] }>>

- Defined in src/GACompanies.ts:56
Parameters
- payload: ICompanyJobTemplatePayload[]
- Optional instanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<{ message: string; templates: ITemplate[] }>>

Static deleteCompanyTemplate

deleteCompanyTemplate(template_id: string, instanceConfig?: IGlobalApiSdkConfig): Promise<IApiResponseObj<{ message: string }>>

- Defined in src/GACompanies.ts:64
Parameters
- template_id: string
- Optional instanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<{ message: string }>>

Static getCompanyInfo

getCompanyInfo(instanceConfig?: IGlobalApiSdkConfig): Promise<IApiResponseObj<ICompany>>

- Defined in src/GACompanies.ts:14
Parameters
- Optional instanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<ICompany>>

Static getCompanyTemplateById

getCompanyTemplateById(id: string, instanceConfig?: IGlobalApiSdkConfig): Promise<IApiResponseObj<ITemplate>>

- Defined in src/GACompanies.ts:24
Parameters
- id: string
- Optional instanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<ITemplate>>

Static getCompanyTemplates

getCompanyTemplates(instanceConfig?: IGlobalApiSdkConfig): Promise<IApiResponseObj<ITemplate[]>>

- Defined in src/GACompanies.ts:19
Parameters
- Optional instanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<ITemplate[]>>

Static getCompanyTemplatesWithIds

getCompanyTemplatesWithIds(ids: string[], instanceConfig?: IGlobalApiSdkConfig): Promise<IApiResponseObj<ITemplate[]>>

- Defined in src/GACompanies.ts:32
Parameters
- ids: string[]
- Optional instanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<ITemplate[]>>

Static populateHeaders

populateHeaders(config: IGlobalApiSdkConfig): IGlobalApiHeaders

Inherited from GlobalApi.populateHeaders
- Defined in src/GlobalAPI.ts:23
Parameters
- config: IGlobalApiSdkConfig
Returns IGlobalApiHeaders

Static setConfig

setConfig(config: IGlobalApiSdkConfig): void

Inherited from GlobalApi.setConfig
- Defined in src/GlobalAPI.ts:35
Parameters
- config: IGlobalApiSdkConfig
Returns void

Static updateCompanyTemplate

updateCompanyTemplate(payload: ICompanyJobTemplateUploadPayload, instanceConfig?: IGlobalApiSdkConfig): Promise<IApiResponseObj<{ message: string }>>

- Defined in src/GACompanies.ts:48
Parameters
- payload: ICompanyJobTemplateUploadPayload
- Optional instanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<{ message: string }>>

Generated using TypeDoc