@nht-pandats/sdk / @nht-pandats/sdk/clients / @nht-pandats/sdk/clients/affiliateApi / AffiliateApiLeadsModule
Class: AffiliateApiLeadsModule
@nht-pandats/sdk/clients.@nht-pandats/sdk/clients/affiliateApi.AffiliateApiLeadsModule
A module for interacting with the leads endpoint of the Affiliate API.
Since
v1.20240429.0
Methods
all
▸ all(options?): Promise<ResponseFields<AffiliateApiLeadModelDefinition>[]>
List all leads matching the specified options via the Affiliate API.
Parameters
| Name | Type | Description |
|---|---|---|
options | Omit<ListMethodOptions<AffiliateApiLeadModelDefinition>, "limit" | "page"> | The options to use when listing all matching leads. |
Returns
Promise<ResponseFields<AffiliateApiLeadModelDefinition>[]>
A list of all matching leads.
Throws
AffiliateApiOperationError If the operation was not successful.
Reference
Defined in
src/clients/affiliateApi/leads.ts:244
create
▸ create(payload): Promise<AffiliateApiOperationResponse<AffiliateApiLeadSaveSuccessfulResponse, AffiliateApiLeadSaveSuccessfulResponse>>
Create a new lead via the Affiliate API.
Parameters
| Name | Type | Description |
|---|---|---|
payload | CreatePayload<AffiliateApiLeadModelDefinition> | The payload for creating a new lead via the Affiliate API. |
Returns
Promise<AffiliateApiOperationResponse<AffiliateApiLeadSaveSuccessfulResponse, AffiliateApiLeadSaveSuccessfulResponse>>
Creation Status and Resource Information on the created client
Throws
AffiliateApiOperationError If the operation was not successful.
Reference
Defined in
src/clients/affiliateApi/leads.ts:270
list
▸ list(options?): Promise<AffiliateApiOperationResponse<ResponseFields<AffiliateApiLeadModelDefinition>[], ResponseFields<AffiliateApiLeadModelDefinition>[]>>
List leads via the Affiliate API.
Parameters
| Name | Type | Description |
|---|---|---|
options | ListMethodOptions<AffiliateApiLeadModelDefinition> | The options to use when listing leads. |
Returns
Promise<AffiliateApiOperationResponse<ResponseFields<AffiliateApiLeadModelDefinition>[], ResponseFields<AffiliateApiLeadModelDefinition>[]>>
List of leads
Throws
AffiliateApiOperationError If the operation was not successful.
Reference
Defined in
src/clients/affiliateApi/leads.ts:222
read
▸ read(email): Promise<AffiliateApiOperationResponse<ResponseFields<AffiliateApiLeadModelDefinition>, ResponseFields<AffiliateApiLeadModelDefinition>>>
Read a lead via the Affiliate API.
Parameters
| Name | Type | Description |
|---|---|---|
email | string | The email of the lead to read. |
Returns
Promise<AffiliateApiOperationResponse<ResponseFields<AffiliateApiLeadModelDefinition>, ResponseFields<AffiliateApiLeadModelDefinition>>>
Lead Information
Throws
AffiliateApiOperationError If the operation was not successful.
Reference
Defined in
src/clients/affiliateApi/leads.ts:289
update
▸ update(email, payload): Promise<AffiliateApiOperationResponse<AffiliateApiLeadSaveSuccessfulResponse, AffiliateApiLeadSaveSuccessfulResponse>>
Update a lead via the Affiliate API.
Parameters
| Name | Type | Description |
|---|---|---|
email | string | The email of the lead to update. |
payload | UpdatePayload<AffiliateApiLeadModelDefinition> | The payload to update on the lead. |
Returns
Promise<AffiliateApiOperationResponse<AffiliateApiLeadSaveSuccessfulResponse, AffiliateApiLeadSaveSuccessfulResponse>>
Update Status and Resource Information on the updated client
Throws
AffiliateApiOperationError If the operation was not successful.
Reference