Class CampaignsApi

Hierarchy

CampaignsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CampaignsApi(basePath?: string): CampaignsApi

- Defined in api/api.ts:28406
Parameters
- Optional basePath: string
Returns CampaignsApi

Properties

Protected basePath

basePath: string = "https://api-na.myconnectwise.net/v4_6_release/apis/3.0"

defaultHeaders

defaultHeaders: any

Methods

marketingCampaignsCountGet

marketingCampaignsCountGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Count>

- Defined in api/api.ts:28419
Get Campaigns Count

Parameters
- params: object
  - Optional conditions?: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Count>

marketingCampaignsGet

marketingCampaignsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<Campaign>>

- Defined in api/api.ts:28460
Get Campaigns

Parameters
- params: object
  - Optional childconditions?: string
  - Optional conditions?: string
  - Optional customfieldconditions?: string
  - Optional orderBy?: string
  - Optional page?: number
  - Optional pageSize?: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Array<Campaign>>

marketingCampaignsIdActivitiesCountGet

marketingCampaignsIdActivitiesCountGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Count>

- Defined in api/api.ts:28516
Get Campaign Activities Count

Parameters
- params: object
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Count>

marketingCampaignsIdActivitiesGet

marketingCampaignsIdActivitiesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<ActivityReference>>

- Defined in api/api.ts:28555
Get Campaign Activities

Parameters
- params: object
  - id: number
  - Optional page?: number
  - Optional pageSize?: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Array<ActivityReference>>

marketingCampaignsIdDelete

marketingCampaignsIdDelete(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

- Defined in api/api.ts:28600
Delete Campaign By Id

Parameters
- params: object
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<__type>

marketingCampaignsIdGet

marketingCampaignsIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Campaign>

- Defined in api/api.ts:28637
Get Campaign By Id

Parameters
- params: object
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Campaign>

marketingCampaignsIdOpportunitiesCountGet

marketingCampaignsIdOpportunitiesCountGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Count>

- Defined in api/api.ts:28674
Get Campaign Opportunities Count

Parameters
- params: object
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Count>

marketingCampaignsIdOpportunitiesGet

marketingCampaignsIdOpportunitiesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<OpportunityReference>>

- Defined in api/api.ts:28713
Get Campaign Opportunities

Parameters
- params: object
  - id: number
  - Optional page?: number
  - Optional pageSize?: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Array<OpportunityReference>>

marketingCampaignsIdPatch

marketingCampaignsIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Campaign>

- Defined in api/api.ts:28759
Update Campaign

Parameters
- params: object
  - id: number
  - operations: Array<PatchOperation>
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Campaign>

marketingCampaignsIdPut

marketingCampaignsIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Campaign>

- Defined in api/api.ts:28804
Replace Campaign

Parameters
- params: object
  - campaign: Campaign
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Campaign>

marketingCampaignsPost

marketingCampaignsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Campaign>

- Defined in api/api.ts:28848
Create Campaign

Parameters
- params: object
  - campaign: Campaign
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Campaign>

Generated using TypeDoc