plivo / plivo-node

A Node library for communicating with the Plivo API and generating Plivo XML.
https://www.plivo.com
MIT License
98 stars 62 forks source link

Issue with tagging Application Id in Verify API #333

Open Hemanth-002 opened 4 months ago

Hemanth-002 commented 4 months ago

The documentation provided here is outdated https://www.plivo.com/docs/verify/api/request/authentication/

I don't see verify_session in the PlivoClient , in verify_session we had app_uuid to tag specific application ID I just see verify, also no mention of how the application ID for Verify API should be added along with verify.initiate

The definition of params is unclear , Can you pls add how the application id should be passed to verify.initiate

export class VerifyInterface extends PlivoResourceInterface {

  constructor(client: Function, data ? : {});

  initiate(phoneNumber: string,params ? : {}): Promise < InitiateVerifyResponse > ;

  verify(verificationUuid: string,otp:string,params ? : {}): Promise < VerifyCallerIdResponse > ;

  updateVerifiedCallerId(phoneNumber: string, params ? : {}): Promise < GetVerifiedCallerIdResponse > ;

  listVerifiedCallerId(params ? : {}): Promise < ListVerifiedCallerIdResponse > ;

  getVerifiedCallerId(phoneNumber: string): Promise < GetVerifiedCallerIdResponse > ;

  deleteVerifiedCallerId(phoneNumber: string): Promise < any > ;
}
narayana-plivo commented 4 months ago

@Hemanth-002 https://www.plivo.com/docs/verify/api/overview/

Hemanth-002 commented 4 months ago

@Hemanth-002 https://www.plivo.com/docs/verify/api/overview/

@narayana-plivo No verify_session in plivoClient

export class Client {
    constructor(authId?: string, authToken?: string, options?: string);
    calls: CallInterface;
    token: TokenInterface;
    accounts: AccountInterface;
    subaccounts: SubaccountInterface;
    subAccounts: SubaccountInterface;
    applications: ApplicationInterface;
    conferences: ConferenceInterface;
    endpoints: EndpointInterface;
    messages: MessageInterface;
    lookup: LookupInterface;
    powerpacks: PowerpackInterface;
    numbers: NumberInterface;
    pricings: PricingInterface;
    recordings: RecordingInterface;
    callFeedback: CallFeedbackInterface;
    media: MediaInterface;
    endUsers: EndUserInterface;
    complianceDocumentTypes: ComplianceDocumentTypeInterface;
    complianceDocuments: ComplianceDocumentInterface;
    complianceRequirements: ComplianceRequirementInterface;
    complianceApplications: ComplianceApplicationInterface;
    loa: LOAInterface;
    hostedMessagingNumber: HostedMessagingNumberInterface;
    maskingSession:MaskingSessionInterface;
    tollfreeVerification: TollfreeVerificationInterface;
    verify:VerifyInterface;
    toJSON(...args: any[]): any;
}
narayana-plivo commented 4 months ago

@Hemanth-002 https://github.com/plivo/plivo-node/blob/master/lib/rest/client.js#L118

Hemanth-002 commented 4 months ago

@Hemanth-002 https://github.com/plivo/plivo-node/blob/master/lib/rest/client.js#L118

@narayana-plivo Thanks for the reference and Please make sure to update corresponding typedefs as well

jt274 commented 2 months ago

@narayana-plivo This is still an issue:

import * as plivo from 'plivo';
let client = new plivo.Client('<auth_id>','<auth_token>'); 
client.verify_session.create({ app_uuid:'<app_uuid>', recipient: '<recipient>', url:'https://<yourdomain>.com/sms_status/', method:'POST', channel:'sms' }).then(function(response) { console.log(response) });

Property 'verify_session' does not exist on type 'Client'. in typescript.

No info about this in the docs, just using the example code does not work.