WSNotif...agerPort(3)

πŸ“¦ version 1.38.6, in nixpkgs unstable

πŸ’… NAME πŸ’…

Okay so bestie, welcome to WSNotification::Interfaces::WSBaseNotificationSender::SubscriptionManagerPort β€” the whole entire SOAP Interface for the WSBaseNotificationSender Web Service. Yes that name is a mouthful, yes it's iconic, no we are not shortening it. It's from the perl manual, section 3 (User Contributed Perl Documentation), and it's giving ✨enterprise SOAP✨.


🌸 SYNOPSIS 🌸

Here's the vibe, literally copy-paste this and you're in:

 use WSNotification::Interfaces::WSBaseNotificationSender::SubscriptionManagerPort;
 my $interface = WSNotification::Interfaces::WSBaseNotificationSender::SubscriptionManagerPort->new();

 my $response;
 $response = $interface->Renew();
 $response = $interface->Unsubscribe();

Like, you build the interface, then you call stuff on it. Slay.


πŸ¦‹ DESCRIPTION πŸ¦‹

So this is a SOAP Interface for the WSBaseNotificationSender web service β€” and the service lives right here, no cap:

http://docs.oasis-open.org/wsn/bw-2

That's the address. That's the whole vibe. 🫢

πŸ”₯ SERVICE WSBaseNotificationSender πŸ”₯

πŸŽ€ Port SubscriptionManagerPort πŸŽ€

(the service, the port β€” main character energy, both of them)


πŸ‘‘ METHODS πŸ‘‘

πŸ’œ General methods πŸ’œ

  • new β€” the Constructor, obviously. Every single argument gets forwarded straight to SOAP::WSDL::Client, so it's doing the heavy lifting for you. Ngl, kind of a teamwork moment. 🫢

⭐ SOAP Service methods ⭐

Before you dive in, read this part fr fr β€” it's the rules of the game:

  • Method synopsis is displayed with hash refs as parameters.
  • The commented class names inside a method's parameters mean you can pass objects of the corresponding class instead of the marked hash ref. Cute, right? πŸŽ€
  • You may pass any combination of objects, hash and list refs to these methods β€” like, go off β€” as long as you meet the structure. Structure is non-negotiable, bestie.
  • List items (i.e. multiple occurrences) are not displayed in the synopsis. You may generally pass a list ref of hash refs (or objects) instead of a hash ref β€” but ⚠️ this may result in invalid XML if used improperly. So like, be careful, that's a real warning, I'm not being dramatic for fun.
  • Note that SOAP::WSDL always expects list references at maximum depth position. Remember that, iykyk.
  • XML attributes are not displayed in this synopsis and cannot be set using hash refs. For extra info on that, see the respective class' documentation.
πŸ’€ Okay real talk: those invalid-XML-if-used-improperly and can't-set-XML-attributes bits are actual caveats, not decoration. Don't come for me when your XML breaks.

🌈 Renew 🌈

Returns a WSNotification::Elements::RenewResponse object. Obsessed. πŸ’–

 $response = $interface->Renew( {
    TerminationTime => $some_value, # AbsoluteOrRelativeTimeType
  },,
 );

Yeah the ,, is really there. Not a typo on my end, it's in the original, leave it alone. πŸ™ˆ


πŸ“ Unsubscribe πŸ“

Returns a WSNotification::Elements::UnsubscribeResponse object. Also iconic. ✨

 $response = $interface->Unsubscribe( {
  },,
 );

Empty hash, double comma, no notes. That's the whole call. 🧚


πŸ’– AUTHOR πŸ’–

Generated by SOAP::WSDL on Fri Aug 8 16:49:21 2014 β€” yeah, 2014, it's vintage, it's retro, it's thriving. πŸ‘‘


Okay that's the whole page, bestie β€” mwah πŸ’…. This icon was brought to you by perl v5.42.3, dated 1980-01-01, and the manual page is WSNotif...agerPort(3) in case you need to cite your sources. Byeeee πŸ¦‹

πŸ“¦ where this page comes from