Skip to content

Commit c336ad5

Browse files
Custard7github-actions[bot]
authored andcommitted
Update python-client SDK to version 3.8.0
1 parent 3304473 commit c336ad5

File tree

1,259 files changed

+98998
-5591
lines changed

Some content is hidden

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

1,259 files changed

+98998
-5591
lines changed

packages/open-api-lcn-clients/python-client/.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,5 +62,5 @@ docs/_build/
6262
# PyBuilder
6363
target/
6464

65-
#Ipython Notebook
65+
# Ipython Notebook
6666
.ipynb_checkpoints

packages/open-api-lcn-clients/python-client/.openapi-generator/FILES

Lines changed: 831 additions & 45 deletions
Large diffs are not rendered by default.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
7.14.0
1+
7.18.0-SNAPSHOT

packages/open-api-lcn-clients/python-client/README.md

Lines changed: 364 additions & 31 deletions
Large diffs are not rendered by default.
Lines changed: 339 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,339 @@
1+
# openapi_client.AppStoreAdminApi
2+
3+
All URIs are relative to *https://network.learncard.com/api*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**app_store_admin_get_all_listings**](AppStoreAdminApi.md#app_store_admin_get_all_listings) | **POST** /app-store/admin/listings | Get All Listings (Admin)
8+
[**app_store_admin_update_listing_status**](AppStoreAdminApi.md#app_store_admin_update_listing_status) | **POST** /app-store/admin/listing/{listingId}/status | Update Listing Status (Admin)
9+
[**app_store_admin_update_promotion_level**](AppStoreAdminApi.md#app_store_admin_update_promotion_level) | **POST** /app-store/admin/listing/{listingId}/promotion | Update Promotion Level (Admin)
10+
[**app_store_is_admin**](AppStoreAdminApi.md#app_store_is_admin) | **GET** /app-store/admin/check | Check Admin Status
11+
12+
13+
# **app_store_admin_get_all_listings**
14+
> AppStoreGetListingsForIntegration200Response app_store_admin_get_all_listings(app_store_admin_get_all_listings_request=app_store_admin_get_all_listings_request)
15+
16+
Get All Listings (Admin)
17+
18+
Get all App Store Listings regardless of status (admin only)
19+
20+
### Example
21+
22+
* Bearer Authentication (Authorization):
23+
24+
```python
25+
import openapi_client
26+
from openapi_client.models.app_store_admin_get_all_listings_request import AppStoreAdminGetAllListingsRequest
27+
from openapi_client.models.app_store_get_listings_for_integration200_response import AppStoreGetListingsForIntegration200Response
28+
from openapi_client.rest import ApiException
29+
from pprint import pprint
30+
31+
# Defining the host is optional and defaults to https://network.learncard.com/api
32+
# See configuration.py for a list of all supported configuration parameters.
33+
configuration = openapi_client.Configuration(
34+
host = "https://network.learncard.com/api"
35+
)
36+
37+
# The client must configure the authentication and authorization parameters
38+
# in accordance with the API server security policy.
39+
# Examples for each auth method are provided below, use the example that
40+
# satisfies your auth use case.
41+
42+
# Configure Bearer authorization: Authorization
43+
configuration = openapi_client.Configuration(
44+
access_token = os.environ["BEARER_TOKEN"]
45+
)
46+
47+
# Enter a context with an instance of the API client
48+
with openapi_client.ApiClient(configuration) as api_client:
49+
# Create an instance of the API class
50+
api_instance = openapi_client.AppStoreAdminApi(api_client)
51+
app_store_admin_get_all_listings_request = openapi_client.AppStoreAdminGetAllListingsRequest() # AppStoreAdminGetAllListingsRequest | (optional)
52+
53+
try:
54+
# Get All Listings (Admin)
55+
api_response = api_instance.app_store_admin_get_all_listings(app_store_admin_get_all_listings_request=app_store_admin_get_all_listings_request)
56+
print("The response of AppStoreAdminApi->app_store_admin_get_all_listings:\n")
57+
pprint(api_response)
58+
except Exception as e:
59+
print("Exception when calling AppStoreAdminApi->app_store_admin_get_all_listings: %s\n" % e)
60+
```
61+
62+
63+
64+
### Parameters
65+
66+
67+
Name | Type | Description | Notes
68+
------------- | ------------- | ------------- | -------------
69+
**app_store_admin_get_all_listings_request** | [**AppStoreAdminGetAllListingsRequest**](AppStoreAdminGetAllListingsRequest.md)| | [optional]
70+
71+
### Return type
72+
73+
[**AppStoreGetListingsForIntegration200Response**](AppStoreGetListingsForIntegration200Response.md)
74+
75+
### Authorization
76+
77+
[Authorization](../README.md#Authorization)
78+
79+
### HTTP request headers
80+
81+
- **Content-Type**: application/json
82+
- **Accept**: application/json
83+
84+
### HTTP response details
85+
86+
| Status code | Description | Response headers |
87+
|-------------|-------------|------------------|
88+
**200** | Successful response | - |
89+
**400** | Invalid input data | - |
90+
**401** | Authorization not provided | - |
91+
**403** | Insufficient access | - |
92+
**500** | Internal server error | - |
93+
94+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
95+
96+
# **app_store_admin_update_listing_status**
97+
> bool app_store_admin_update_listing_status(listing_id, app_store_admin_update_listing_status_request)
98+
99+
Update Listing Status (Admin)
100+
101+
Update the status of an App Store Listing (admin only)
102+
103+
### Example
104+
105+
* Bearer Authentication (Authorization):
106+
107+
```python
108+
import openapi_client
109+
from openapi_client.models.app_store_admin_update_listing_status_request import AppStoreAdminUpdateListingStatusRequest
110+
from openapi_client.rest import ApiException
111+
from pprint import pprint
112+
113+
# Defining the host is optional and defaults to https://network.learncard.com/api
114+
# See configuration.py for a list of all supported configuration parameters.
115+
configuration = openapi_client.Configuration(
116+
host = "https://network.learncard.com/api"
117+
)
118+
119+
# The client must configure the authentication and authorization parameters
120+
# in accordance with the API server security policy.
121+
# Examples for each auth method are provided below, use the example that
122+
# satisfies your auth use case.
123+
124+
# Configure Bearer authorization: Authorization
125+
configuration = openapi_client.Configuration(
126+
access_token = os.environ["BEARER_TOKEN"]
127+
)
128+
129+
# Enter a context with an instance of the API client
130+
with openapi_client.ApiClient(configuration) as api_client:
131+
# Create an instance of the API class
132+
api_instance = openapi_client.AppStoreAdminApi(api_client)
133+
listing_id = 'listing_id_example' # str |
134+
app_store_admin_update_listing_status_request = openapi_client.AppStoreAdminUpdateListingStatusRequest() # AppStoreAdminUpdateListingStatusRequest |
135+
136+
try:
137+
# Update Listing Status (Admin)
138+
api_response = api_instance.app_store_admin_update_listing_status(listing_id, app_store_admin_update_listing_status_request)
139+
print("The response of AppStoreAdminApi->app_store_admin_update_listing_status:\n")
140+
pprint(api_response)
141+
except Exception as e:
142+
print("Exception when calling AppStoreAdminApi->app_store_admin_update_listing_status: %s\n" % e)
143+
```
144+
145+
146+
147+
### Parameters
148+
149+
150+
Name | Type | Description | Notes
151+
------------- | ------------- | ------------- | -------------
152+
**listing_id** | **str**| |
153+
**app_store_admin_update_listing_status_request** | [**AppStoreAdminUpdateListingStatusRequest**](AppStoreAdminUpdateListingStatusRequest.md)| |
154+
155+
### Return type
156+
157+
**bool**
158+
159+
### Authorization
160+
161+
[Authorization](../README.md#Authorization)
162+
163+
### HTTP request headers
164+
165+
- **Content-Type**: application/json
166+
- **Accept**: application/json
167+
168+
### HTTP response details
169+
170+
| Status code | Description | Response headers |
171+
|-------------|-------------|------------------|
172+
**200** | Successful response | - |
173+
**400** | Invalid input data | - |
174+
**401** | Authorization not provided | - |
175+
**403** | Insufficient access | - |
176+
**500** | Internal server error | - |
177+
178+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
179+
180+
# **app_store_admin_update_promotion_level**
181+
> bool app_store_admin_update_promotion_level(listing_id, app_store_admin_update_promotion_level_request)
182+
183+
Update Promotion Level (Admin)
184+
185+
Update the promotion level of an App Store Listing (admin only)
186+
187+
### Example
188+
189+
* Bearer Authentication (Authorization):
190+
191+
```python
192+
import openapi_client
193+
from openapi_client.models.app_store_admin_update_promotion_level_request import AppStoreAdminUpdatePromotionLevelRequest
194+
from openapi_client.rest import ApiException
195+
from pprint import pprint
196+
197+
# Defining the host is optional and defaults to https://network.learncard.com/api
198+
# See configuration.py for a list of all supported configuration parameters.
199+
configuration = openapi_client.Configuration(
200+
host = "https://network.learncard.com/api"
201+
)
202+
203+
# The client must configure the authentication and authorization parameters
204+
# in accordance with the API server security policy.
205+
# Examples for each auth method are provided below, use the example that
206+
# satisfies your auth use case.
207+
208+
# Configure Bearer authorization: Authorization
209+
configuration = openapi_client.Configuration(
210+
access_token = os.environ["BEARER_TOKEN"]
211+
)
212+
213+
# Enter a context with an instance of the API client
214+
with openapi_client.ApiClient(configuration) as api_client:
215+
# Create an instance of the API class
216+
api_instance = openapi_client.AppStoreAdminApi(api_client)
217+
listing_id = 'listing_id_example' # str |
218+
app_store_admin_update_promotion_level_request = openapi_client.AppStoreAdminUpdatePromotionLevelRequest() # AppStoreAdminUpdatePromotionLevelRequest |
219+
220+
try:
221+
# Update Promotion Level (Admin)
222+
api_response = api_instance.app_store_admin_update_promotion_level(listing_id, app_store_admin_update_promotion_level_request)
223+
print("The response of AppStoreAdminApi->app_store_admin_update_promotion_level:\n")
224+
pprint(api_response)
225+
except Exception as e:
226+
print("Exception when calling AppStoreAdminApi->app_store_admin_update_promotion_level: %s\n" % e)
227+
```
228+
229+
230+
231+
### Parameters
232+
233+
234+
Name | Type | Description | Notes
235+
------------- | ------------- | ------------- | -------------
236+
**listing_id** | **str**| |
237+
**app_store_admin_update_promotion_level_request** | [**AppStoreAdminUpdatePromotionLevelRequest**](AppStoreAdminUpdatePromotionLevelRequest.md)| |
238+
239+
### Return type
240+
241+
**bool**
242+
243+
### Authorization
244+
245+
[Authorization](../README.md#Authorization)
246+
247+
### HTTP request headers
248+
249+
- **Content-Type**: application/json
250+
- **Accept**: application/json
251+
252+
### HTTP response details
253+
254+
| Status code | Description | Response headers |
255+
|-------------|-------------|------------------|
256+
**200** | Successful response | - |
257+
**400** | Invalid input data | - |
258+
**401** | Authorization not provided | - |
259+
**403** | Insufficient access | - |
260+
**500** | Internal server error | - |
261+
262+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
263+
264+
# **app_store_is_admin**
265+
> bool app_store_is_admin()
266+
267+
Check Admin Status
268+
269+
Check if the current user is an App Store administrator
270+
271+
### Example
272+
273+
* Bearer Authentication (Authorization):
274+
275+
```python
276+
import openapi_client
277+
from openapi_client.rest import ApiException
278+
from pprint import pprint
279+
280+
# Defining the host is optional and defaults to https://network.learncard.com/api
281+
# See configuration.py for a list of all supported configuration parameters.
282+
configuration = openapi_client.Configuration(
283+
host = "https://network.learncard.com/api"
284+
)
285+
286+
# The client must configure the authentication and authorization parameters
287+
# in accordance with the API server security policy.
288+
# Examples for each auth method are provided below, use the example that
289+
# satisfies your auth use case.
290+
291+
# Configure Bearer authorization: Authorization
292+
configuration = openapi_client.Configuration(
293+
access_token = os.environ["BEARER_TOKEN"]
294+
)
295+
296+
# Enter a context with an instance of the API client
297+
with openapi_client.ApiClient(configuration) as api_client:
298+
# Create an instance of the API class
299+
api_instance = openapi_client.AppStoreAdminApi(api_client)
300+
301+
try:
302+
# Check Admin Status
303+
api_response = api_instance.app_store_is_admin()
304+
print("The response of AppStoreAdminApi->app_store_is_admin:\n")
305+
pprint(api_response)
306+
except Exception as e:
307+
print("Exception when calling AppStoreAdminApi->app_store_is_admin: %s\n" % e)
308+
```
309+
310+
311+
312+
### Parameters
313+
314+
This endpoint does not need any parameter.
315+
316+
### Return type
317+
318+
**bool**
319+
320+
### Authorization
321+
322+
[Authorization](../README.md#Authorization)
323+
324+
### HTTP request headers
325+
326+
- **Content-Type**: Not defined
327+
- **Accept**: application/json
328+
329+
### HTTP response details
330+
331+
| Status code | Description | Response headers |
332+
|-------------|-------------|------------------|
333+
**200** | Successful response | - |
334+
**401** | Authorization not provided | - |
335+
**403** | Insufficient access | - |
336+
**500** | Internal server error | - |
337+
338+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
339+
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# AppStoreAdminGetAllListingsRequest
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**limit** | **float** | | [optional]
9+
**cursor** | **str** | | [optional]
10+
**status** | **str** | | [optional]
11+
12+
## Example
13+
14+
```python
15+
from openapi_client.models.app_store_admin_get_all_listings_request import AppStoreAdminGetAllListingsRequest
16+
17+
# TODO update the JSON string below
18+
json = "{}"
19+
# create an instance of AppStoreAdminGetAllListingsRequest from a JSON string
20+
app_store_admin_get_all_listings_request_instance = AppStoreAdminGetAllListingsRequest.from_json(json)
21+
# print the JSON string representation of the object
22+
print(AppStoreAdminGetAllListingsRequest.to_json())
23+
24+
# convert the object into a dict
25+
app_store_admin_get_all_listings_request_dict = app_store_admin_get_all_listings_request_instance.to_dict()
26+
# create an instance of AppStoreAdminGetAllListingsRequest from a dict
27+
app_store_admin_get_all_listings_request_from_dict = AppStoreAdminGetAllListingsRequest.from_dict(app_store_admin_get_all_listings_request_dict)
28+
```
29+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
30+
31+

0 commit comments

Comments
 (0)