Class GupshupPartnerApiClient

Gupshup Partner API Client

Provides methods to interact with the Gupshup Partner API for managing subscriptions, templates, business profiles, media, and other partner-related operations.

Example

const client = new GupshupPartnerApiClient({
  appId: 'your-app-id',
  appToken: 'your-app-token',
  debug: true
});

const templates = await client.getTemplates();

Constructors

constructor

new GupshupPartnerApiClient(
config: GupshupPartnerApiClientConfig,
): GupshupPartnerApiClient
Creates a new GupshupPartnerApiClient instance
Parameters
- config: GupshupPartnerApiClientConfig
  Configuration object containing app credentials and options
Returns GupshupPartnerApiClient
Throws
When appId or appToken are empty
- Defined in GupshupPartnerApiClient/GupshupPartnerApiClient.ts:55

Methods

addOptIn

addOptIn(phone: string): Promise<any>
Adds a phone number to the opt-in list
Parameters
- phone: string
  The phone number to opt-in
Returns Promise<any>
Promise resolving to opt-in result
- Defined in GupshupPartnerApiClient/GupshupPartnerApiClient.ts:201

addSubscription

addSubscription(
data: PartnerSubscriptionDataAdd,
): Promise<AxiosResponse<any, any>>
Creates a new subscription
Parameters
- data: PartnerSubscriptionDataAdd
  Subscription data to create
Returns Promise<AxiosResponse<any, any>>
Promise resolving to created subscription data
- Defined in GupshupPartnerApiClient/GupshupPartnerApiClient.ts:111

checkHealth

checkHealth(): Promise<any>
Checks the health status of the API

Returns Promise<any>
Promise resolving to health status data
- Defined in GupshupPartnerApiClient/GupshupPartnerApiClient.ts:247

deleteAllSubscriptions

deleteAllSubscriptions(): Promise<AxiosResponse<any, any>>
Deletes all subscriptions for the partner app

Returns Promise<AxiosResponse<any, any>>
Promise resolving to deletion result
- Defined in GupshupPartnerApiClient/GupshupPartnerApiClient.ts:138

deleteSubscription

deleteSubscription(subscriptionId: string): Promise<AxiosResponse<any, any>>
Deletes a specific subscription
Parameters
- subscriptionId: string
  The unique identifier of the subscription to delete
Returns Promise<AxiosResponse<any, any>>
Promise resolving to deletion result
- Defined in GupshupPartnerApiClient/GupshupPartnerApiClient.ts:130

delTemplate

delTemplate(elementName: string): Promise<any>
Deletes a template by element name
Parameters
- elementName: string
  The element name of the template to delete
Returns Promise<any>
Promise resolving to deletion result
- Defined in GupshupPartnerApiClient/GupshupPartnerApiClient.ts:179

disableButtonClickAnalytics

disableButtonClickAnalytics(templateId: string): Promise<any>
Disables button click analytics for a template
Parameters
- templateId: string
  The template ID to disable analytics for
Returns Promise<any>
Promise resolving to analytics disable result
- Defined in GupshupPartnerApiClient/GupshupPartnerApiClient.ts:299

downloadMedia

downloadMedia(mediaId: string): Promise<any>
Downloads media by media ID
Parameters
- mediaId: string
  The media ID to download
Returns Promise<any>
Promise resolving to media data
- Defined in GupshupPartnerApiClient/GupshupPartnerApiClient.ts:334

editTemplate

editTemplate(templateId: string, templateData: TemplateEditData): Promise<any>
Updates an existing template
Parameters
- templateId: string
  The unique identifier of the template to update
- templateData: TemplateEditData
  Updated template data
Returns Promise<any>
Promise resolving to updated template data
- Defined in GupshupPartnerApiClient/GupshupPartnerApiClient.ts:169

generateMediaIdUsingUpload

generateMediaIdUsingUpload(file: any, fileType: string): Promise<any>
Uploads a file and generates a media ID
Parameters
- file: any
  The file to upload
- fileType: string
  The type of the file
Returns Promise<any>
Promise resolving to media ID and upload result
- Defined in GupshupPartnerApiClient/GupshupPartnerApiClient.ts:314

getAllSubscriptions

getAllSubscriptions(): Promise<AxiosResponse<any, any>>
Retrieves all subscriptions for the partner app

Returns Promise<AxiosResponse<any, any>>
Promise resolving to subscription data
- Defined in GupshupPartnerApiClient/GupshupPartnerApiClient.ts:93

getBusinessProfileAbout

getBusinessProfileAbout(): Promise<any>
Gets business profile about information

Returns Promise<any>
Promise resolving to business profile about data
- Defined in GupshupPartnerApiClient/GupshupPartnerApiClient.ts:369

getBusinessProfileDetails

getBusinessProfileDetails(): Promise<any>
Gets business profile details

Returns Promise<any>
Promise resolving to business profile data
- Defined in GupshupPartnerApiClient/GupshupPartnerApiClient.ts:360

getBusinessProfilePhoto

getBusinessProfilePhoto(): Promise<any>
Gets business profile photo

Returns Promise<any>
Promise resolving to business profile photo data
- Defined in GupshupPartnerApiClient/GupshupPartnerApiClient.ts:378

getDiscount

getDiscount(year: string, month: string): Promise<any>
Gets discount information for a specific year and month
Parameters
- year: string
  The year (YYYY format)
- month: string
  The month (MM format)
Returns Promise<any>
Promise resolving to discount data
- Defined in GupshupPartnerApiClient/GupshupPartnerApiClient.ts:347

getMessageLimit

getMessageLimit(): Promise<any>
Gets message limits and ratings

Returns Promise<any>
Promise resolving to message limits and ratings data
- Defined in GupshupPartnerApiClient/GupshupPartnerApiClient.ts:256

getQualityRating

getQualityRating(): Promise<any>
Gets quality rating information

Returns Promise<any>
Promise resolving to quality rating data
- Defined in GupshupPartnerApiClient/GupshupPartnerApiClient.ts:265

getSubscription

getSubscription(subscriptionId: string): Promise<AxiosResponse<any, any>>
Retrieves a specific subscription by ID
Parameters
- subscriptionId: string
  The unique identifier of the subscription
Returns Promise<AxiosResponse<any, any>>
Promise resolving to subscription data
- Defined in GupshupPartnerApiClient/GupshupPartnerApiClient.ts:102

getTemplates

getTemplates(): Promise<Template[]>
Retrieves all templates for the partner app

Returns Promise<Template[]>
Promise resolving to array of templates
- Defined in GupshupPartnerApiClient/GupshupPartnerApiClient.ts:148

getUsage

getUsage(from: string, to: string): Promise<any>
Gets usage statistics for a date range
Parameters
- from: string
  Start date in YYYY-MM-DD format
- to: string
  End date in YYYY-MM-DD format
Returns Promise<any>
Promise resolving to usage statistics
- Defined in GupshupPartnerApiClient/GupshupPartnerApiClient.ts:287

getUserStatus

getUserStatus(phone: string): Promise<any>
Gets the status of a user by phone number
Parameters
- phone: string
  The phone number to check
Returns Promise<any>
Promise resolving to user status
- Defined in GupshupPartnerApiClient/GupshupPartnerApiClient.ts:211

getWABAInfo

getWABAInfo(): Promise<any>
Gets WABA (WhatsApp Business Account) information

Returns Promise<any>
Promise resolving to WABA information
- Defined in GupshupPartnerApiClient/GupshupPartnerApiClient.ts:274

getWalletBalance

getWalletBalance(): Promise<any>
Gets the wallet balance

Returns Promise<any>
Promise resolving to wallet balance data
- Defined in GupshupPartnerApiClient/GupshupPartnerApiClient.ts:238

isPhoneOpted

isPhoneOpted(phone: string): Promise<boolean>
Checks if a phone number is opted in
Parameters
- phone: string
  The phone number to check
Returns Promise<boolean>
Promise resolving to boolean indicating if phone is opted in
- Defined in GupshupPartnerApiClient/GupshupPartnerApiClient.ts:223

postTemplate

postTemplate(templateData: TemplateCreateData): Promise<any>
Creates a new template
Parameters
- templateData: TemplateCreateData
  Template creation data
Returns Promise<any>
Promise resolving to created template data
- Defined in GupshupPartnerApiClient/GupshupPartnerApiClient.ts:158

putCallBackUrl

putCallBackUrl(callbackUrl: string): Promise<any>
Sets the callback URL for webhook notifications
Parameters
- callbackUrl: string
  The URL to receive webhook notifications
Returns Promise<any>
Promise resolving to callback URL setting result
- Defined in GupshupPartnerApiClient/GupshupPartnerApiClient.ts:191

updateEvents

updateEvents(events: string[]): Promise<boolean>
Updates event modes for callbacks
Parameters
- events: string[]
  Array of event types to enable
Returns Promise<boolean>
Promise resolving to boolean indicating success

Deprecated
This method is deprecated and may be removed in future versions
- Defined in GupshupPartnerApiClient/GupshupPartnerApiClient.ts:391

updateSubscription

updateSubscription(
subscriptionId: string,
data: PartnerSubscriptionDataUpdate,
): Promise<AxiosResponse<any, any>>
Updates an existing subscription
Parameters
- subscriptionId: string
  The unique identifier of the subscription to update
- data: PartnerSubscriptionDataUpdate
  Updated subscription data
Returns Promise<AxiosResponse<any, any>>
Promise resolving to updated subscription data
- Defined in GupshupPartnerApiClient/GupshupPartnerApiClient.ts:121

Class GupshupPartnerApiClient

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns GupshupPartnerApiClient

Throws

Methods

addOptIn

Parameters

Returns Promise<any>

addSubscription

Parameters

Returns Promise<AxiosResponse<any, any>>

checkHealth

Returns Promise<any>

deleteAllSubscriptions

Returns Promise<AxiosResponse<any, any>>

deleteSubscription

Parameters

Returns Promise<AxiosResponse<any, any>>

delTemplate

Parameters

Returns Promise<any>

disableButtonClickAnalytics

Parameters

Returns Promise<any>

downloadMedia

Parameters

Returns Promise<any>

editTemplate

Parameters

Returns Promise<any>

generateMediaIdUsingUpload

Parameters

Returns Promise<any>

getAllSubscriptions

Returns Promise<AxiosResponse<any, any>>

getBusinessProfileAbout

Returns Promise<any>

getBusinessProfileDetails

Returns Promise<any>

getBusinessProfilePhoto

Returns Promise<any>

getDiscount

Parameters

Returns Promise<any>

getMessageLimit

Returns Promise<any>

getQualityRating

Returns Promise<any>

getSubscription

Parameters

Returns Promise<AxiosResponse<any, any>>

getTemplates

Returns Promise<Template[]>

getUsage

Parameters

Returns Promise<any>

getUserStatus

Parameters

Returns Promise<any>

getWABAInfo

Returns Promise<any>

getWalletBalance

Returns Promise<any>

isPhoneOpted

Parameters

Returns Promise<boolean>

postTemplate

Parameters

Returns Promise<any>

putCallBackUrl

Parameters

Returns Promise<any>

updateEvents

Parameters