Class GACompanies

Hierarchy (View Summary)

GlobalApi
- GACompanies

Index

Constructors

Properties

Methods

makeApiCall createCompanyTemplate createCompanyTemplateBulk deleteCompanyTemplate getCompanyInfo getCompanyTemplateById getCompanyTemplates getCompanyTemplatesWithIds populateHeaders setConfig updateCompanyTemplate

Constructors

constructor

new GACompanies(instanceConfig?: IGlobalApiSdkConfig): GACompanies
Parameters
- OptionalinstanceConfig: IGlobalApiSdkConfig
Returns GACompanies
Inherited from GlobalApi.constructor
- Defined in src/GlobalAPI.ts:40

Properties

`Static`config

config: IGlobalApiSdkConfig

Methods

`Protected`makeApiCall

makeApiCall(action: string, data?: indexedObject): IGlobalApiCallConfig
Parameters
- action: string
- Optionaldata: indexedObject
Returns IGlobalApiCallConfig
Inherited from GlobalApi.makeApiCall
- Defined in src/GlobalAPI.ts:52

`Static`createCompanyTemplate

createCompanyTemplate(
payload: ICompanyJobTemplatePayload,
instanceConfig?: IGlobalApiSdkConfig,
): Promise<IApiResponseObj<{ message: string; template: ITemplate }>>
Parameters
- payload: ICompanyJobTemplatePayload
- OptionalinstanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<{ message: string; template: ITemplate }>>
- Defined in src/GACompanies.ts:40

`Static`createCompanyTemplateBulk

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

`Static`deleteCompanyTemplate

deleteCompanyTemplate(
template_id: string,
instanceConfig?: IGlobalApiSdkConfig,
): Promise<IApiResponseObj<{ message: string }>>
Parameters
- template_id: string
- OptionalinstanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<{ message: string }>>
- Defined in src/GACompanies.ts:64

`Static`getCompanyInfo

getCompanyInfo(
instanceConfig?: IGlobalApiSdkConfig,
): Promise<IApiResponseObj<ICompany>>
Parameters
- OptionalinstanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<ICompany>>
- Defined in src/GACompanies.ts:14

`Static`getCompanyTemplateById

getCompanyTemplateById(
id: string,
instanceConfig?: IGlobalApiSdkConfig,
): Promise<IApiResponseObj<ITemplate>>
Parameters
- id: string
- OptionalinstanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<ITemplate>>
- Defined in src/GACompanies.ts:24

`Static`getCompanyTemplates

getCompanyTemplates(
instanceConfig?: IGlobalApiSdkConfig,
): Promise<IApiResponseObj<ITemplate[]>>
Parameters
- OptionalinstanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<ITemplate[]>>
- Defined in src/GACompanies.ts:19

`Static`getCompanyTemplatesWithIds

getCompanyTemplatesWithIds(
ids: string[],
instanceConfig?: IGlobalApiSdkConfig,
): Promise<IApiResponseObj<ITemplate[]>>
Parameters
- ids: string[]
- OptionalinstanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<ITemplate[]>>
- Defined in src/GACompanies.ts:32

`Static`populateHeaders

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

`Static`setConfig

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

`Static`updateCompanyTemplate

updateCompanyTemplate(
payload: ICompanyJobTemplateUploadPayload,
instanceConfig?: IGlobalApiSdkConfig,
): Promise<IApiResponseObj<{ message: string }>>
Parameters
- payload: ICompanyJobTemplateUploadPayload
- OptionalinstanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<{ message: string }>>
- Defined in src/GACompanies.ts:48