Class PublicSMTPTokensApi

Index

Constructors

Methods

archiveToken archiveTokenWithHttpInfo createToken createTokenWithHttpInfo getTokenById getTokenByIdWithHttpInfo getTokensPage getTokensPageWithHttpInfo resetPassword resetPasswordWithHttpInfo

Constructors

constructor

new PublicSMTPTokensApi(configuration, requestFactory?, responseProcessor?): PublicSMTPTokensApi
Parameters
- configuration: Configuration<ObservableMiddleware>
- OptionalrequestFactory: PublicSMTPTokensApiRequestFactory
- OptionalresponseProcessor: PublicSMTPTokensApiResponseProcessor
Returns PublicSMTPTokensApi
- Defined in codegen/marketing/transactional/types/PromiseAPI.ts:16

Methods

archiveToken

archiveToken(tokenId, _options?): Promise<void>
Delete a single token by ID. Delete a single token by ID.
Parameters
- tokenId: string
  Identifier generated when a token is created.
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/marketing/transactional/types/PromiseAPI.ts:51

archiveTokenWithHttpInfo

archiveTokenWithHttpInfo(tokenId, _options?): Promise<HttpInfo<void>>
Delete a single token by ID. Delete a single token by ID.
Parameters
- tokenId: string
  Identifier generated when a token is created.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/marketing/transactional/types/PromiseAPI.ts:29

createToken

createToken(smtpApiTokenRequestEgg, _options?): Promise<SmtpApiTokenView>
Create a SMTP API token. Create a SMTP API token.
Parameters
- smtpApiTokenRequestEgg: SmtpApiTokenRequestEgg
  A request object that includes the campaign name tied to the token and whether contacts should be created for email recipients.
- Optional_options: PromiseConfigurationOptions
Returns Promise<SmtpApiTokenView>
- Defined in codegen/marketing/transactional/types/PromiseAPI.ts:95

createTokenWithHttpInfo

createTokenWithHttpInfo(smtpApiTokenRequestEgg, _options?): Promise<HttpInfo<SmtpApiTokenView>>
Create a SMTP API token. Create a SMTP API token.
Parameters
- smtpApiTokenRequestEgg: SmtpApiTokenRequestEgg
  A request object that includes the campaign name tied to the token and whether contacts should be created for email recipients.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<SmtpApiTokenView>>
- Defined in codegen/marketing/transactional/types/PromiseAPI.ts:73

getTokenById

getTokenById(tokenId, _options?): Promise<SmtpApiTokenView>
Query a single token by ID. Query a single token by ID.
Parameters
- tokenId: string
  Identifier generated when a token is created.
- Optional_options: PromiseConfigurationOptions
Returns Promise<SmtpApiTokenView>
- Defined in codegen/marketing/transactional/types/PromiseAPI.ts:139

getTokenByIdWithHttpInfo

getTokenByIdWithHttpInfo(tokenId, _options?): Promise<HttpInfo<SmtpApiTokenView>>
Query a single token by ID. Query a single token by ID.
Parameters
- tokenId: string
  Identifier generated when a token is created.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<SmtpApiTokenView>>
- Defined in codegen/marketing/transactional/types/PromiseAPI.ts:117

getTokensPage

getTokensPage(campaignName?, emailCampaignId?, after?, limit?, _options?): Promise<CollectionResponseSmtpApiTokenViewForwardPaging>
Query multiple SMTP API tokens by campaign name or a single token by emailCampaignId. Query SMTP API tokens by campaign name or an emailCampaignId.
Parameters
- OptionalcampaignName: string
  A name for the campaign tied to the SMTP API token.
- OptionalemailCampaignId: string
  Identifier assigned to the campaign provided during the token creation.
- Optionalafter: string
  Starting point to get the next set of results.
- Optionallimit: number
  Maximum number of tokens to return.
- Optional_options: PromiseConfigurationOptions
Returns Promise<CollectionResponseSmtpApiTokenViewForwardPaging>
- Defined in codegen/marketing/transactional/types/PromiseAPI.ts:189

getTokensPageWithHttpInfo

getTokensPageWithHttpInfo(campaignName?, emailCampaignId?, after?, limit?, _options?): Promise<HttpInfo<CollectionResponseSmtpApiTokenViewForwardPaging>>
Query multiple SMTP API tokens by campaign name or a single token by emailCampaignId. Query SMTP API tokens by campaign name or an emailCampaignId.
Parameters
- OptionalcampaignName: string
  A name for the campaign tied to the SMTP API token.
- OptionalemailCampaignId: string
  Identifier assigned to the campaign provided during the token creation.
- Optionalafter: string
  Starting point to get the next set of results.
- Optionallimit: number
  Maximum number of tokens to return.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<CollectionResponseSmtpApiTokenViewForwardPaging>>
- Defined in codegen/marketing/transactional/types/PromiseAPI.ts:164

resetPassword

resetPassword(tokenId, _options?): Promise<SmtpApiTokenView>
Allows the creation of a replacement password for a given token. Once the password is successfully reset, the old password for the token will be invalid. Reset the password of an existing token.
Parameters
- tokenId: string
  Identifier generated when a token is created.
- Optional_options: PromiseConfigurationOptions
Returns Promise<SmtpApiTokenView>
- Defined in codegen/marketing/transactional/types/PromiseAPI.ts:233

resetPasswordWithHttpInfo

resetPasswordWithHttpInfo(tokenId, _options?): Promise<HttpInfo<SmtpApiTokenView>>
Allows the creation of a replacement password for a given token. Once the password is successfully reset, the old password for the token will be invalid. Reset the password of an existing token.
Parameters
- tokenId: string
  Identifier generated when a token is created.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<SmtpApiTokenView>>
- Defined in codegen/marketing/transactional/types/PromiseAPI.ts:211

Class PublicSMTPTokensApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns PublicSMTPTokensApi

Methods

archiveToken

Parameters

Returns Promise<void>

archiveTokenWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

createToken

Parameters

Returns Promise<SmtpApiTokenView>

createTokenWithHttpInfo

Parameters

Returns Promise<HttpInfo<SmtpApiTokenView>>

getTokenById

Parameters

Returns Promise<SmtpApiTokenView>

getTokenByIdWithHttpInfo

Parameters

Returns Promise<HttpInfo<SmtpApiTokenView>>

getTokensPage

Parameters

Returns Promise<CollectionResponseSmtpApiTokenViewForwardPaging>

getTokensPageWithHttpInfo

Parameters

Returns Promise<HttpInfo<CollectionResponseSmtpApiTokenViewForwardPaging>>

resetPassword

Parameters

Returns Promise<SmtpApiTokenView>

resetPasswordWithHttpInfo

Parameters

Returns Promise<HttpInfo<SmtpApiTokenView>>

Settings

On This Page