Skip to content

Commit 81e6b86

Browse files
SDK updates
1 parent dcb4cc4 commit 81e6b86

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+3058
-1769
lines changed

Diff for: README.md

+110-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Telstra Programmable Network API Bash client
1+
# Telstra Programmable Network
22

33
## Overview
44
This is a Bash client script for accessing Telstra Programmable Network API service.
55

6-
The script uses cURL underneath for making all REST calls.
6+
The script uses cURL underneath for making all REST calls.
77

88
## Usage
99

@@ -86,3 +86,111 @@ fi
8686

8787
### Zsh
8888
In Zsh, the generated `_TelstraTPN` Zsh completion file must be copied to one of the folders under `$FPATH` variable.
89+
90+
91+
## Documentation for API Endpoints
92+
93+
All URIs are relative to **
94+
95+
Class | Method | HTTP request | Description
96+
------------ | ------------- | ------------- | -------------
97+
*AuthenticationApi* | [**authGeneratetokenPost**](docs/AuthenticationApi.md#authgeneratetokenpost) | **POST** /1.0.0/auth/generatetoken | Create an authentication token
98+
*AuthenticationApi* | [**authValidatetokenGet**](docs/AuthenticationApi.md#authvalidatetokenget) | **GET** /1.0.0/auth/validatetoken | Validate authentication token
99+
*ContractsApi* | [**inventoryLinksContractByLinkidAndContractidGet**](docs/ContractsApi.md#inventorylinkscontractbylinkidandcontractidget) | **GET** /1.0.0/inventory/links/{linkid}/contract/{contractid} | Get active Contract by ContractID
100+
*ContractsApi* | [**inventoryLinksContractByLinkidAndContractidPut**](docs/ContractsApi.md#inventorylinkscontractbylinkidandcontractidput) | **PUT** /1.0.0/inventory/links/{linkid}/contract/{contractid} | Update active Contract by ContractID
101+
*ContractsApi* | [**inventoryLinksContractByLinkidPost**](docs/ContractsApi.md#inventorylinkscontractbylinkidpost) | **POST** /1.0.0/inventory/links/{linkid}/contract | Create new Contract on specified link
102+
*CustomersApi* | [**accountByCustomeruuidGet**](docs/CustomersApi.md#accountbycustomeruuidget) | **GET** /1.0.0/account/{customeruuid} | Get account information details
103+
*CustomersApi* | [**accountUserByCustomeruuidGet**](docs/CustomersApi.md#accountuserbycustomeruuidget) | **GET** /1.0.0/account/{customeruuid}/user | List users
104+
*DatacentresApi* | [**inventoryDatacentersGet**](docs/DatacentresApi.md#inventorydatacentersget) | **GET** /1.0.0/inventory/datacenters | Get list of all the data centers
105+
*EndpointsApi* | [**eis100EndpointsAssignTopologyTagByEndpointuuidPost**](docs/EndpointsApi.md#eis100endpointsassigntopologytagbyendpointuuidpost) | **POST** /eis/1.0.0/endpoints/{endpointuuid}/assign_topology_tag | Assign a Topology Tag to an Endpoint
106+
*EndpointsApi* | [**inventoryEndpointByEndpointuuidGet**](docs/EndpointsApi.md#inventoryendpointbyendpointuuidget) | **GET** /1.0.0/inventory/endpoint/{endpointuuid} | Get information about the specified endpoint
107+
*EndpointsApi* | [**inventoryEndpointsCustomeruuidByCustomeruuidGet**](docs/EndpointsApi.md#inventoryendpointscustomeruuidbycustomeruuidget) | **GET** /1.0.0/inventory/endpoints/customeruuid/{customeruuid} | Get list of endpoints for a customer
108+
*EndpointsApi* | [**inventoryRegularendpointPost**](docs/EndpointsApi.md#inventoryregularendpointpost) | **POST** /1.0.0/inventory/regularendpoint | Create Physical (Port) Endpoint
109+
*EndpointsApi* | [**inventoryVnfendpointPost**](docs/EndpointsApi.md#inventoryvnfendpointpost) | **POST** /1.0.0/inventory/vnfendpoint | Create VNF Endpoint
110+
*LinksApi* | [**inventoryLinkPost**](docs/LinksApi.md#inventorylinkpost) | **POST** /1.0.0/inventory/link | Create Link and initial Contract
111+
*LinksApi* | [**inventoryLinksByLinkidGet**](docs/LinksApi.md#inventorylinksbylinkidget) | **GET** /1.0.0/inventory/links/{linkid} | Get details of specified link
112+
*LinksApi* | [**inventoryLinksCustomerByCustomeruuidGet**](docs/LinksApi.md#inventorylinkscustomerbycustomeruuidget) | **GET** /1.0.0/inventory/links/customer/{customeruuid} | Get active Links
113+
*LinksApi* | [**inventoryLinksHistoryByLinkidGet**](docs/LinksApi.md#inventorylinkshistorybylinkidget) | **GET** /1.0.0/inventory/links/history/{linkid} | Get Link history
114+
*TopologiesApi* | [**ttms100TopologyTagByTopotaguuidDelete**](docs/TopologiesApi.md#ttms100topologytagbytopotaguuiddelete) | **DELETE** /ttms/1.0.0/topology_tag/{topotaguuid}/ | Delete a topology tag
115+
*TopologiesApi* | [**ttms100TopologyTagByTopotaguuidGet**](docs/TopologiesApi.md#ttms100topologytagbytopotaguuidget) | **GET** /ttms/1.0.0/topology_tag/{topotaguuid}/ | Get information about the specified topology tag
116+
*TopologiesApi* | [**ttms100TopologyTagByTopotaguuidPut**](docs/TopologiesApi.md#ttms100topologytagbytopotaguuidput) | **PUT** /ttms/1.0.0/topology_tag/{topotaguuid}/ | Update a topology tag's name and/or description
117+
*TopologiesApi* | [**ttms100TopologyTagGet**](docs/TopologiesApi.md#ttms100topologytagget) | **GET** /ttms/1.0.0/topology_tag | List all topology tags
118+
*TopologiesApi* | [**ttms100TopologyTagObjectsByTopotaguuidGet**](docs/TopologiesApi.md#ttms100topologytagobjectsbytopotaguuidget) | **GET** /ttms/1.0.0/topology_tag/{topotaguuid}/objects/ | List objects for Topology
119+
*TopologiesApi* | [**ttms100TopologyTagPost**](docs/TopologiesApi.md#ttms100topologytagpost) | **POST** /ttms/1.0.0/topology_tag | Create a named topology tag
120+
*VnfsApi* | [**marketplaceImageGet**](docs/VnfsApi.md#marketplaceimageget) | **GET** /1.0.0/marketplace/image | List images in the Marketplace
121+
*VportsApi* | [**inventoryRegularvportPost**](docs/VportsApi.md#inventoryregularvportpost) | **POST** /1.0.0/inventory/regularvport | Create VPort for physical endpoint
122+
*VportsApi* | [**inventoryVnfVportPost**](docs/VportsApi.md#inventoryvnfvportpost) | **POST** /1.0.0/inventory/vnf/vport | Create VNF VPort
123+
*VportsApi* | [**inventoryVportByVportuuidGet**](docs/VportsApi.md#inventoryvportbyvportuuidget) | **GET** /1.0.0/inventory/vport/{vportuuid} | Get information about the specified VPort
124+
125+
126+
## Documentation For Models
127+
128+
- [AccountResponse](docs/AccountResponse.md)
129+
- [AuthGeneratetokenResponse](docs/AuthGeneratetokenResponse.md)
130+
- [AuthValidatetokenResponse](docs/AuthValidatetokenResponse.md)
131+
- [Billing](docs/Billing.md)
132+
- [Classification](docs/Classification.md)
133+
- [Contract](docs/Contract.md)
134+
- [Datacenter](docs/Datacenter.md)
135+
- [Eis100EndpointsAssignTopologyTagRequest](docs/Eis100EndpointsAssignTopologyTagRequest.md)
136+
- [Endpoint](docs/Endpoint.md)
137+
- [EndpointPort](docs/EndpointPort.md)
138+
- [Endpointlist](docs/Endpointlist.md)
139+
- [Error](docs/Error.md)
140+
- [Error74](docs/Error74.md)
141+
- [Flavor](docs/Flavor.md)
142+
- [GlanceImage](docs/GlanceImage.md)
143+
- [InventoryDatacenters401Error](docs/InventoryDatacenters401Error.md)
144+
- [InventoryDatacentersResponse](docs/InventoryDatacentersResponse.md)
145+
- [InventoryEndpointResponse](docs/InventoryEndpointResponse.md)
146+
- [InventoryEndpointsCustomeruuidResponse](docs/InventoryEndpointsCustomeruuidResponse.md)
147+
- [InventoryLinkRequest](docs/InventoryLinkRequest.md)
148+
- [InventoryLinkResponse](docs/InventoryLinkResponse.md)
149+
- [InventoryLinksContractRequest](docs/InventoryLinksContractRequest.md)
150+
- [InventoryLinksContractRequest37](docs/InventoryLinksContractRequest37.md)
151+
- [InventoryLinksContractResponse](docs/InventoryLinksContractResponse.md)
152+
- [InventoryLinksContractResponse33](docs/InventoryLinksContractResponse33.md)
153+
- [InventoryLinksContractResponse38](docs/InventoryLinksContractResponse38.md)
154+
- [InventoryLinksHistoryResponse](docs/InventoryLinksHistoryResponse.md)
155+
- [InventoryLinksResponse](docs/InventoryLinksResponse.md)
156+
- [InventoryRegularendpointRequest](docs/InventoryRegularendpointRequest.md)
157+
- [InventoryRegularendpointResponse](docs/InventoryRegularendpointResponse.md)
158+
- [InventoryRegularvportRequest](docs/InventoryRegularvportRequest.md)
159+
- [InventoryRegularvportResponse](docs/InventoryRegularvportResponse.md)
160+
- [InventoryVnfVportRequest](docs/InventoryVnfVportRequest.md)
161+
- [InventoryVnfVportResponse](docs/InventoryVnfVportResponse.md)
162+
- [InventoryVnfendpointRequest](docs/InventoryVnfendpointRequest.md)
163+
- [InventoryVnfendpointResponse](docs/InventoryVnfendpointResponse.md)
164+
- [Link](docs/Link.md)
165+
- [Link66](docs/Link66.md)
166+
- [MarketplaceImageResponse](docs/MarketplaceImageResponse.md)
167+
- [Meta](docs/Meta.md)
168+
- [Object52](docs/Object52.md)
169+
- [Params](docs/Params.md)
170+
- [Params31](docs/Params31.md)
171+
- [Params34](docs/Params34.md)
172+
- [Params39](docs/Params39.md)
173+
- [Product](docs/Product.md)
174+
- [Role](docs/Role.md)
175+
- [SuccessFragment](docs/SuccessFragment.md)
176+
- [Topology](docs/Topology.md)
177+
- [Ttms100TopologyTagObjectsResponse](docs/Ttms100TopologyTagObjectsResponse.md)
178+
- [Ttms100TopologyTagRequest](docs/Ttms100TopologyTagRequest.md)
179+
- [User](docs/User.md)
180+
- [Vlan](docs/Vlan.md)
181+
- [VnfTag](docs/VnfTag.md)
182+
- [Vport](docs/Vport.md)
183+
- [Vportvalue](docs/Vportvalue.md)
184+
185+
186+
## Documentation For Authorization
187+
188+
189+
## auth
190+
191+
- **Type**: OAuth
192+
- **Flow**: password
193+
- **Token URL**: https://penapi.pacnetconnect.com/1.0.0/auth/generatetoken
194+
- **Scopes**:
195+
- **Oauth2**: Oauth2
196+

0 commit comments

Comments
 (0)