Skip to content

Commit 9860779

Browse files
author
PureCloud Jenkins
committed
24.0.0
1 parent 5577315 commit 9860779

59 files changed

Lines changed: 3455 additions & 924 deletions

Some content is hidden

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

‎README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ npm install purecloud-platform-client-v2
2525
Reference from the CDN:
2626

2727
~~~ html
28-
<!-- Replace `23.2.0` with the version you want to use. -->
29-
<script src="https://sdk-cdn.mypurecloud.com/javascript/23.2.0/purecloud-platform-client-v2.min.js"></script>
28+
<!-- Replace `24.0.0` with the version you want to use. -->
29+
<script src="https://sdk-cdn.mypurecloud.com/javascript/24.0.0/purecloud-platform-client-v2.min.js"></script>
3030
~~~
3131

3232
View the documentation on the [PureCloud Developer Center](https://developer.mypurecloud.com/api/rest/client-libraries/javascript/).
@@ -41,7 +41,7 @@ Reference the SDK in your HTML document. For convenience, all modules are bundle
4141

4242
~~~ html
4343
<!-- Include the full library -->
44-
<script src="https://sdk-cdn.mypurecloud.com/javascript/23.2.0/purecloud-platform-client-v2.min.js"></script>
44+
<script src="https://sdk-cdn.mypurecloud.com/javascript/24.0.0/purecloud-platform-client-v2.min.js"></script>
4545
~~~
4646

4747

@@ -88,7 +88,7 @@ const platformClient = require('platformClient');
8888
var client = platformClient.ApiClient.instance;
8989
client.loginImplicitGrant(clientId, redirectUri, { state: state })
9090
.then(function(data) {
91-
console.log(data);
91+
console.log(data);
9292
// Do authenticated things
9393
})
9494
.catch(function(err) {

‎build/README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ npm install purecloud-platform-client-v2
2525
Reference from the CDN:
2626

2727
~~~ html
28-
<!-- Replace `23.2.0` with the version you want to use. -->
29-
<script src="https://sdk-cdn.mypurecloud.com/javascript/23.2.0/purecloud-platform-client-v2.min.js"></script>
28+
<!-- Replace `24.0.0` with the version you want to use. -->
29+
<script src="https://sdk-cdn.mypurecloud.com/javascript/24.0.0/purecloud-platform-client-v2.min.js"></script>
3030
~~~
3131

3232
View the documentation on the [PureCloud Developer Center](https://developer.mypurecloud.com/api/rest/client-libraries/javascript/).
@@ -41,7 +41,7 @@ Reference the SDK in your HTML document. For convenience, all modules are bundle
4141

4242
~~~ html
4343
<!-- Include the full library -->
44-
<script src="https://sdk-cdn.mypurecloud.com/javascript/23.2.0/purecloud-platform-client-v2.min.js"></script>
44+
<script src="https://sdk-cdn.mypurecloud.com/javascript/24.0.0/purecloud-platform-client-v2.min.js"></script>
4545
~~~
4646

4747

@@ -88,7 +88,7 @@ const platformClient = require('platformClient');
8888
var client = platformClient.ApiClient.instance;
8989
client.loginImplicitGrant(clientId, redirectUri, { state: state })
9090
.then(function(data) {
91-
console.log(data);
91+
console.log(data);
9292
// Do authenticated things
9393
})
9494
.catch(function(err) {

‎build/docs/AppFoundryApi.md‎

Lines changed: 195 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,195 @@
1+
---
2+
title: AppFoundryApi
3+
---
4+
# platformClient.AppFoundryApi
5+
6+
All URIs are relative to *https://api.mypurecloud.com*
7+
8+
| Method | HTTP request | Description |
9+
| ------------- | ------------- | ------------- |
10+
[**getAppfoundryPlatformNameCategories**](AppFoundryApi.html#getAppfoundryPlatformNameCategories) | **GET** /api/v2/appfoundry/{platformName}/categories | Return a structured hierarchy of available listing categories
11+
[**getAppfoundryPlatformNameCategory**](AppFoundryApi.html#getAppfoundryPlatformNameCategory) | **GET** /api/v2/appfoundry/{platformName}/categories/{categoryName} | Get listings that are part of the specified root category or a contained subcategory
12+
[**getAppfoundryPlatformNameCategorySubCategoryName**](AppFoundryApi.html#getAppfoundryPlatformNameCategorySubCategoryName) | **GET** /api/v2/appfoundry/{platformName}/categories/{categoryName}/{subCategoryName} | Get listings that are part of the specified subcategory
13+
{: class="table table-striped"}
14+
15+
<a name="getAppfoundryPlatformNameCategories"></a>
16+
17+
# [AppFoundryListingCategory] getAppfoundryPlatformNameCategories(platformName)
18+
19+
GET /api/v2/appfoundry/{platformName}/categories
20+
21+
Return a structured hierarchy of available listing categories
22+
23+
24+
25+
### Example
26+
27+
~~~ javascript
28+
// Browser
29+
const platformClient = require('platformClient');
30+
// Node
31+
const platformClient = require('purecloud-platform-client-v2');
32+
33+
// Configure OAuth2 access token for authorization: PureCloud Auth
34+
platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken = 'YOUR ACCESS TOKEN';
35+
36+
var apiInstance = new platformClient.AppFoundryApi();
37+
38+
var platformName = "platformName_example"; // String |
39+
40+
apiInstance.getAppfoundryPlatformNameCategories(platformName)
41+
.then(function(data) {
42+
console.log(`getAppfoundryPlatformNameCategories success! data: ${JSON.stringify(data, null, 2)}`);
43+
})
44+
.catch(function(err) {
45+
console.log('There was a failure calling getAppfoundryPlatformNameCategories');
46+
console.error(err);
47+
});
48+
49+
~~~
50+
51+
### Parameters
52+
53+
54+
| Name | Type | Description | Notes |
55+
| ------------- | ------------- | ------------- | ------------- |
56+
**platformName** | **String** | | |
57+
{: class="table table-striped"}
58+
59+
### Return type
60+
61+
**[AppFoundryListingCategory]**
62+
63+
<a name="getAppfoundryPlatformNameCategory"></a>
64+
65+
# PagedListingEntity getAppfoundryPlatformNameCategory(platformName, categoryName, opts)
66+
67+
GET /api/v2/appfoundry/{platformName}/categories/{categoryName}
68+
69+
Get listings that are part of the specified root category or a contained subcategory
70+
71+
72+
73+
### Example
74+
75+
~~~ javascript
76+
// Browser
77+
const platformClient = require('platformClient');
78+
// Node
79+
const platformClient = require('purecloud-platform-client-v2');
80+
81+
// Configure OAuth2 access token for authorization: PureCloud Auth
82+
platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken = 'YOUR ACCESS TOKEN';
83+
84+
var apiInstance = new platformClient.AppFoundryApi();
85+
86+
var platformName = "platformName_example"; // String |
87+
88+
var categoryName = "categoryName_example"; // String | Name of category to request listings from
89+
90+
var opts = {
91+
'pageSize': 25, // Number | The total page size requested
92+
'pageNumber': 1, // Number | The page number requested
93+
'sortBy': "sortBy_example", // String | variable name requested to sort by
94+
'expand': null, // [Object] | variable name requested by expand list
95+
'nextPage': "nextPage_example", // String | next page token
96+
'previousPage': "previousPage_example" // String | Previous page token
97+
};
98+
apiInstance.getAppfoundryPlatformNameCategory(platformName, categoryName, opts)
99+
.then(function(data) {
100+
console.log(`getAppfoundryPlatformNameCategory success! data: ${JSON.stringify(data, null, 2)}`);
101+
})
102+
.catch(function(err) {
103+
console.log('There was a failure calling getAppfoundryPlatformNameCategory');
104+
console.error(err);
105+
});
106+
107+
~~~
108+
109+
### Parameters
110+
111+
112+
| Name | Type | Description | Notes |
113+
| ------------- | ------------- | ------------- | ------------- |
114+
**platformName** | **String** | | |
115+
**categoryName** | **String** | Name of category to request listings from | |
116+
**pageSize** | **Number** | The total page size requested | [optional] [default to 25] |
117+
**pageNumber** | **Number** | The page number requested | [optional] [default to 1] |
118+
**sortBy** | **String** | variable name requested to sort by | [optional] |
119+
**expand** | **[Object]** | variable name requested by expand list | [optional] |
120+
**nextPage** | **String** | next page token | [optional] |
121+
**previousPage** | **String** | Previous page token | [optional] |
122+
{: class="table table-striped"}
123+
124+
### Return type
125+
126+
**PagedListingEntity**
127+
128+
<a name="getAppfoundryPlatformNameCategorySubCategoryName"></a>
129+
130+
# PagedListingEntity getAppfoundryPlatformNameCategorySubCategoryName(platformName, categoryName, subCategoryName, opts)
131+
132+
GET /api/v2/appfoundry/{platformName}/categories/{categoryName}/{subCategoryName}
133+
134+
Get listings that are part of the specified subcategory
135+
136+
137+
138+
### Example
139+
140+
~~~ javascript
141+
// Browser
142+
const platformClient = require('platformClient');
143+
// Node
144+
const platformClient = require('purecloud-platform-client-v2');
145+
146+
// Configure OAuth2 access token for authorization: PureCloud Auth
147+
platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken = 'YOUR ACCESS TOKEN';
148+
149+
var apiInstance = new platformClient.AppFoundryApi();
150+
151+
var platformName = "platformName_example"; // String |
152+
153+
var categoryName = "categoryName_example"; // String | Name of category to request listings from
154+
155+
var subCategoryName = "subCategoryName_example"; // String | Name of subcategory to request listings from
156+
157+
var opts = {
158+
'pageSize': 25, // Number | The total page size requested
159+
'pageNumber': 1, // Number | The page number requested
160+
'sortBy': "sortBy_example", // String | variable name requested to sort by
161+
'expand': null, // [Object] | variable name requested by expand list
162+
'nextPage': "nextPage_example", // String | next page token
163+
'previousPage': "previousPage_example" // String | Previous page token
164+
};
165+
apiInstance.getAppfoundryPlatformNameCategorySubCategoryName(platformName, categoryName, subCategoryName, opts)
166+
.then(function(data) {
167+
console.log(`getAppfoundryPlatformNameCategorySubCategoryName success! data: ${JSON.stringify(data, null, 2)}`);
168+
})
169+
.catch(function(err) {
170+
console.log('There was a failure calling getAppfoundryPlatformNameCategorySubCategoryName');
171+
console.error(err);
172+
});
173+
174+
~~~
175+
176+
### Parameters
177+
178+
179+
| Name | Type | Description | Notes |
180+
| ------------- | ------------- | ------------- | ------------- |
181+
**platformName** | **String** | | |
182+
**categoryName** | **String** | Name of category to request listings from | |
183+
**subCategoryName** | **String** | Name of subcategory to request listings from | |
184+
**pageSize** | **Number** | The total page size requested | [optional] [default to 25] |
185+
**pageNumber** | **Number** | The page number requested | [optional] [default to 1] |
186+
**sortBy** | **String** | variable name requested to sort by | [optional] |
187+
**expand** | **[Object]** | variable name requested by expand list | [optional] |
188+
**nextPage** | **String** | next page token | [optional] |
189+
**previousPage** | **String** | Previous page token | [optional] |
190+
{: class="table table-striped"}
191+
192+
### Return type
193+
194+
**PagedListingEntity**
195+

0 commit comments

Comments
 (0)