partner

Operation: POST /dataservice/partner/{partnerType}

Register NMS partner

def post(
    partner_type: str, payload: RegisterPartnerRequest
) -> RegisterPartnerRes: ...

Example:

from catalyswan.core import create_client

url = "example.com"
username = "admin"
password = "password123"

with create_client(
    url=url, username=username, password=password
) as client:
    client.partner.post()

Operation: PUT /dataservice/partner/{partnerType}/{nmsId}

Update NMS partner details

def put(
    partner_type: str, nms_id: str, payload: UpdatePartnerRequest
) -> None: ...

Example:

from catalyswan.core import create_client

url = "example.com"
username = "admin"
password = "password123"

with create_client(
    url=url, username=username, password=password
) as client:
    client.partner.put()

Operation: DELETE /dataservice/partner/{partnerType}/{nmsId}

Delete NMS partner

def delete(partner_type: str, nms_id: str) -> StatusResponse: ...

Example:

from catalyswan.core import create_client

url = "example.com"
username = "admin"
password = "password123"

with create_client(
    url=url, username=username, password=password
) as client:
    client.partner.delete()

Operation: GET /dataservice/partner

@overload
def get() -> List[PartnerRes]: ...

Example:

from catalyswan.core import create_client

url = "example.com"
username = "admin"
password = "password123"

with create_client(
    url=url, username=username, password=password
) as client:
    client.partner.get()

Operation: GET /dataservice/partner/{partnerType}

@overload
def get(partner_type: str) -> List[PartnerRes]: ...

Example:

from catalyswan.core import create_client

url = "example.com"
username = "admin"
password = "password123"

with create_client(
    url=url, username=username, password=password
) as client:
    client.partner.get()

Operation: GET /dataservice/partner/{partnerType}/{nmsId}

@overload
def get(partner_type: str, nms_id: str) -> PartnerRes: ...

Example:

from catalyswan.core import create_client

url = "example.com"
username = "admin"
password = "password123"

with create_client(
    url=url, username=username, password=password
) as client:
    client.partner.get()