-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathGroupsApi.java
More file actions
203 lines (164 loc) · 18.6 KB
/
GroupsApi.java
File metadata and controls
203 lines (164 loc) · 18.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
package factset.analyticsapi.engines.api;
import factset.analyticsapi.engines.ApiException;
import factset.analyticsapi.engines.ApiClient;
import factset.analyticsapi.engines.ApiResponse;
import factset.analyticsapi.engines.Configuration;
import factset.analyticsapi.engines.Pair;
import javax.ws.rs.core.GenericType;
import java.util.HashMap;
import java.util.Map;
import java.io.File;
import factset.analyticsapi.engines.models.FrequencyRoot;
import factset.analyticsapi.engines.models.GroupRoot;
/**
* @deprecated DEPRECATED! Use <a href="https://central.sonatype.com/search?q=com.factset.sdk&smo=true">Esdk's</a>.
*/
@Deprecated
@javax.annotation.Generated(value = "CustomJavaClientCodegen")
public class GroupsApi {
private ApiClient apiClient;
public GroupsApi() {
this(Configuration.getDefaultApiClient());
}
public GroupsApi(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* Get the API cilent
*
* @return API client
*/
public ApiClient getApiClient() {
return apiClient;
}
/**
* Set the API cilent
*
* @param apiClient an instance of API client
*/
public void setApiClient(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* Get PA grouping frequencies
* This endpoint lists all the PA grouping frequencies that can be applied to a PA calculation.
@return FrequencyRoot
* @throws ApiException if fails to make API call
* @http.response.details
<table summary="Response Details" border="1">
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> Expected response, returns a list of PA grouping frequencies </td><td> * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br> * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br> * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br> </td></tr>
<tr><td> 401 </td><td> Missing or invalid authentication. </td><td> * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> </td></tr>
<tr><td> 403 </td><td> User is forbidden with current credentials </td><td> * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br> * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br> * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br> </td></tr>
<tr><td> 406 </td><td> Unsupported Accept header. Header needs to be set to application/json. </td><td> * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br> * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br> * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br> </td></tr>
<tr><td> 429 </td><td> Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. </td><td> * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached. <br> </td></tr>
<tr><td> 500 </td><td> Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting </td><td> * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> </td></tr>
<tr><td> 503 </td><td> Request timed out. Retry the request in sometime. </td><td> * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> </td></tr>
</table>
*/
public FrequencyRoot getPAGroupingFrequencies() throws ApiException {
return getPAGroupingFrequenciesWithHttpInfo().getData();
}
/**
* Get PA grouping frequencies
* This endpoint lists all the PA grouping frequencies that can be applied to a PA calculation.
* @return ApiResponse<FrequencyRoot>
* @throws ApiException if fails to make API call
* @http.response.details
<table summary="Response Details" border="1">
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> Expected response, returns a list of PA grouping frequencies </td><td> * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br> * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br> * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br> </td></tr>
<tr><td> 401 </td><td> Missing or invalid authentication. </td><td> * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> </td></tr>
<tr><td> 403 </td><td> User is forbidden with current credentials </td><td> * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br> * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br> * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br> </td></tr>
<tr><td> 406 </td><td> Unsupported Accept header. Header needs to be set to application/json. </td><td> * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br> * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br> * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br> </td></tr>
<tr><td> 429 </td><td> Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. </td><td> * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached. <br> </td></tr>
<tr><td> 500 </td><td> Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting </td><td> * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> </td></tr>
<tr><td> 503 </td><td> Request timed out. Retry the request in sometime. </td><td> * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> </td></tr>
</table>
*/
public ApiResponse<FrequencyRoot> getPAGroupingFrequenciesWithHttpInfo() throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/analytics/engines/pa/v3/grouping-frequencies";
// query params
java.util.List<Pair> localVarQueryParams = new java.util.ArrayList<Pair>();
java.util.Map<String, String> localVarHeaderParams = new java.util.HashMap<String, String>();
java.util.Map<String, String> localVarCookieParams = new java.util.HashMap<String, String>();
java.util.Map<String, Object> localVarFormParams = new java.util.HashMap<String, Object>();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "Basic", "Bearer" };
GenericType<FrequencyRoot> localVarReturnType = new GenericType<FrequencyRoot>() {};
Map<Integer, GenericType> returnTypeMap = new HashMap<Integer, GenericType>();
returnTypeMap.put(200, new GenericType<FrequencyRoot>(){});
return apiClient.<FrequencyRoot>invokeAPIWithReturnMap("GroupsApi.getPAGroupingFrequencies", localVarPath, "GET", localVarQueryParams, localVarPostBody,
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, returnTypeMap, false);
}
/**
* Get PA groups
* This endpoint lists all the PA groups that can be applied to a PA calculation.
@return GroupRoot
* @throws ApiException if fails to make API call
* @http.response.details
<table summary="Response Details" border="1">
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> Expected response, returns a list of PA groups </td><td> * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> * Age - Standard HTTP header. Header will specify the age of groupings list cached response. <br> * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br> * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br> * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br> </td></tr>
<tr><td> 401 </td><td> Missing or invalid authentication. </td><td> * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> </td></tr>
<tr><td> 403 </td><td> User is forbidden with current credentials </td><td> * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br> * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br> * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br> </td></tr>
<tr><td> 406 </td><td> Unsupported Accept header. Header needs to be set to application/json. </td><td> * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br> * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br> * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br> </td></tr>
<tr><td> 429 </td><td> Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. </td><td> * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached. <br> </td></tr>
<tr><td> 500 </td><td> Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting </td><td> * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> </td></tr>
<tr><td> 503 </td><td> Request timed out. Retry the request in sometime. </td><td> * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> </td></tr>
</table>
*/
public GroupRoot getPAGroups() throws ApiException {
return getPAGroupsWithHttpInfo().getData();
}
/**
* Get PA groups
* This endpoint lists all the PA groups that can be applied to a PA calculation.
* @return ApiResponse<GroupRoot>
* @throws ApiException if fails to make API call
* @http.response.details
<table summary="Response Details" border="1">
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> Expected response, returns a list of PA groups </td><td> * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> * Age - Standard HTTP header. Header will specify the age of groupings list cached response. <br> * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br> * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br> * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br> </td></tr>
<tr><td> 401 </td><td> Missing or invalid authentication. </td><td> * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> </td></tr>
<tr><td> 403 </td><td> User is forbidden with current credentials </td><td> * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br> * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br> * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br> </td></tr>
<tr><td> 406 </td><td> Unsupported Accept header. Header needs to be set to application/json. </td><td> * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br> * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br> * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br> </td></tr>
<tr><td> 429 </td><td> Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. </td><td> * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached. <br> </td></tr>
<tr><td> 500 </td><td> Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting </td><td> * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> </td></tr>
<tr><td> 503 </td><td> Request timed out. Retry the request in sometime. </td><td> * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> </td></tr>
</table>
*/
public ApiResponse<GroupRoot> getPAGroupsWithHttpInfo() throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/analytics/engines/pa/v3/groups";
// query params
java.util.List<Pair> localVarQueryParams = new java.util.ArrayList<Pair>();
java.util.Map<String, String> localVarHeaderParams = new java.util.HashMap<String, String>();
java.util.Map<String, String> localVarCookieParams = new java.util.HashMap<String, String>();
java.util.Map<String, Object> localVarFormParams = new java.util.HashMap<String, Object>();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "Basic", "Bearer" };
GenericType<GroupRoot> localVarReturnType = new GenericType<GroupRoot>() {};
Map<Integer, GenericType> returnTypeMap = new HashMap<Integer, GenericType>();
returnTypeMap.put(200, new GenericType<GroupRoot>(){});
return apiClient.<GroupRoot>invokeAPIWithReturnMap("GroupsApi.getPAGroups", localVarPath, "GET", localVarQueryParams, localVarPostBody,
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, returnTypeMap, false);
}
}