Class CardsApi

Index

Constructors

Methods

archive archiveWithHttpInfo create createWithHttpInfo getAll getAllWithHttpInfo getById getByIdWithHttpInfo update updateWithHttpInfo

Constructors

constructor

new CardsApi(configuration, requestFactory?, responseProcessor?): CardsApi
Parameters
- configuration: Configuration
- OptionalrequestFactory: CardsApiRequestFactory
- OptionalresponseProcessor: CardsApiResponseProcessor
Returns CardsApi
- Defined in codegen/crm/extensions/cards/types/PromiseAPI.ts:15

Methods

archiveWithHttpInfo

archiveWithHttpInfo(cardId, appId, _options?): Promise<HttpInfo<void>>
Permanently deletes a card definition with the given ID. Once deleted, data fetch requests for this card will no longer be sent to your service. This can't be undone. Delete a card
Parameters
- cardId: string
  The ID of the card to delete.
- appId: number
  The ID of the target app.
- Optional_options: Configuration
Returns Promise<HttpInfo<void>>
- Defined in codegen/crm/extensions/cards/types/PromiseAPI.ts:29

create

create(appId, cardCreateRequest, _options?): Promise<PublicCardResponse>
Defines a new card that will become active on an account when this app is installed. Create a new card
Parameters
- appId: number
  The ID of the target app.
- cardCreateRequest: CardCreateRequest
  The new card definition.
- Optional_options: Configuration
Returns Promise<PublicCardResponse>
- Defined in codegen/crm/extensions/cards/types/PromiseAPI.ts:62

createWithHttpInfo

createWithHttpInfo(appId, cardCreateRequest, _options?): Promise<HttpInfo<PublicCardResponse>>
Defines a new card that will become active on an account when this app is installed. Create a new card
Parameters
- appId: number
  The ID of the target app.
- cardCreateRequest: CardCreateRequest
  The new card definition.
- Optional_options: Configuration
Returns Promise<HttpInfo<PublicCardResponse>>
- Defined in codegen/crm/extensions/cards/types/PromiseAPI.ts:51

getAll

getAll(appId, _options?): Promise<PublicCardListResponse>
Returns a list of cards for a given app. Get all cards
Parameters
- appId: number
  The ID of the target app.
- Optional_options: Configuration
Returns Promise<PublicCardListResponse>
- Defined in codegen/crm/extensions/cards/types/PromiseAPI.ts:82

getAllWithHttpInfo

getAllWithHttpInfo(appId, _options?): Promise<HttpInfo<PublicCardListResponse>>
Returns a list of cards for a given app. Get all cards
Parameters
- appId: number
  The ID of the target app.
- Optional_options: Configuration
Returns Promise<HttpInfo<PublicCardListResponse>>
- Defined in codegen/crm/extensions/cards/types/PromiseAPI.ts:72

getById

getById(cardId, appId, _options?): Promise<PublicCardResponse>
Returns the definition for a card with the given ID. Get a card.
Parameters
- cardId: string
  The ID of the target card.
- appId: number
  The ID of the target app.
- Optional_options: Configuration
Returns Promise<PublicCardResponse>
- Defined in codegen/crm/extensions/cards/types/PromiseAPI.ts:104

getByIdWithHttpInfo

getByIdWithHttpInfo(cardId, appId, _options?): Promise<HttpInfo<PublicCardResponse>>
Returns the definition for a card with the given ID. Get a card.
Parameters
- cardId: string
  The ID of the target card.
- appId: number
  The ID of the target app.
- Optional_options: Configuration
Returns Promise<HttpInfo<PublicCardResponse>>
- Defined in codegen/crm/extensions/cards/types/PromiseAPI.ts:93

update

update(cardId, appId, cardPatchRequest, _options?): Promise<PublicCardResponse>
Update a card definition with new details. Update a card
Parameters
- cardId: string
  The ID of the card to update.
- appId: number
  The ID of the target app.
- cardPatchRequest: CardPatchRequest
  Card definition fields to be updated.
- Optional_options: Configuration
Returns Promise<PublicCardResponse>
- Defined in codegen/crm/extensions/cards/types/PromiseAPI.ts:128

updateWithHttpInfo

updateWithHttpInfo(cardId, appId, cardPatchRequest, _options?): Promise<HttpInfo<PublicCardResponse>>
Update a card definition with new details. Update a card
Parameters
- cardId: string
  The ID of the card to update.
- appId: number
  The ID of the target app.
- cardPatchRequest: CardPatchRequest
  Card definition fields to be updated.
- Optional_options: Configuration
Returns Promise<HttpInfo<PublicCardResponse>>
- Defined in codegen/crm/extensions/cards/types/PromiseAPI.ts:116

Class CardsApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CardsApi

Methods

archive

Parameters

Returns Promise<void>

archiveWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

create

Parameters

Returns Promise<PublicCardResponse>

createWithHttpInfo

Parameters

Returns Promise<HttpInfo<PublicCardResponse>>

getAll

Parameters

Returns Promise<PublicCardListResponse>

getAllWithHttpInfo

Parameters

Returns Promise<HttpInfo<PublicCardListResponse>>

getById

Parameters

Returns Promise<PublicCardResponse>

getByIdWithHttpInfo

Parameters

Returns Promise<HttpInfo<PublicCardResponse>>

update

Parameters

Returns Promise<PublicCardResponse>

updateWithHttpInfo

Parameters

Returns Promise<HttpInfo<PublicCardResponse>>

Settings

On This Page