@griffin-app/griffin-hub-sdk 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (90) hide show
  1. package/.openapi-generator/FILES +68 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/.openapi-generator-ignore +23 -0
  4. package/README.md +132 -0
  5. package/api.ts +2057 -0
  6. package/base.ts +62 -0
  7. package/common.ts +113 -0
  8. package/configuration.ts +121 -0
  9. package/dist/api.d.ts +1218 -0
  10. package/dist/api.js +1603 -0
  11. package/dist/base.d.ts +42 -0
  12. package/dist/base.js +46 -0
  13. package/dist/common.d.ts +28 -0
  14. package/dist/common.js +124 -0
  15. package/dist/configuration.d.ts +98 -0
  16. package/dist/configuration.js +44 -0
  17. package/dist/esm/api.d.ts +1218 -0
  18. package/dist/esm/api.js +1579 -0
  19. package/dist/esm/base.d.ts +42 -0
  20. package/dist/esm/base.js +41 -0
  21. package/dist/esm/common.d.ts +28 -0
  22. package/dist/esm/common.js +112 -0
  23. package/dist/esm/configuration.d.ts +98 -0
  24. package/dist/esm/configuration.js +40 -0
  25. package/dist/esm/index.d.ts +13 -0
  26. package/dist/esm/index.js +15 -0
  27. package/dist/index.d.ts +13 -0
  28. package/dist/index.js +31 -0
  29. package/docs/AgentsApi.md +265 -0
  30. package/docs/AgentsGet200Response.md +22 -0
  31. package/docs/AgentsGet200ResponseDataInner.md +30 -0
  32. package/docs/AgentsIdHeartbeatPost200Response.md +20 -0
  33. package/docs/AgentsIdHeartbeatPost404Response.md +20 -0
  34. package/docs/AgentsLocationsGet200Response.md +20 -0
  35. package/docs/AgentsRegisterPost200Response.md +30 -0
  36. package/docs/AgentsRegisterPostRequest.md +22 -0
  37. package/docs/Assertion.md +30 -0
  38. package/docs/Assertion1.md +30 -0
  39. package/docs/Assertion1AnyOf.md +28 -0
  40. package/docs/Assertion1AnyOf1.md +24 -0
  41. package/docs/Assertion1AnyOf2.md +24 -0
  42. package/docs/Assertions.md +24 -0
  43. package/docs/Assertions1.md +24 -0
  44. package/docs/BinaryPredicate.md +22 -0
  45. package/docs/BinaryPredicate1.md +22 -0
  46. package/docs/BinaryPredicateOperator.md +30 -0
  47. package/docs/ConfigApi.md +330 -0
  48. package/docs/ConfigGet200Response.md +20 -0
  49. package/docs/ConfigOrganizationIdEnvironmentTargetsTargetKeyGet200Response.md +20 -0
  50. package/docs/ConfigOrganizationIdEnvironmentTargetsTargetKeyGet200ResponseData.md +20 -0
  51. package/docs/ConfigOrganizationIdEnvironmentTargetsTargetKeyPut200Response.md +20 -0
  52. package/docs/ConfigOrganizationIdEnvironmentTargetsTargetKeyPut200ResponseData.md +30 -0
  53. package/docs/ConfigOrganizationIdEnvironmentTargetsTargetKeyPutRequest.md +20 -0
  54. package/docs/DefaultApi.md +51 -0
  55. package/docs/Edge.md +22 -0
  56. package/docs/Edge1.md +22 -0
  57. package/docs/Endpoint.md +34 -0
  58. package/docs/Endpoint1.md +34 -0
  59. package/docs/Endpoint1Base.md +22 -0
  60. package/docs/Endpoint1HeadersValue.md +20 -0
  61. package/docs/Endpoint1HeadersValueAnyOf.md +20 -0
  62. package/docs/Endpoint1HeadersValueAnyOfSecret.md +26 -0
  63. package/docs/Frequency.md +22 -0
  64. package/docs/Frequency1.md +22 -0
  65. package/docs/HttpMethod.md +24 -0
  66. package/docs/JSONAssertion.md +26 -0
  67. package/docs/JSONAssertion1Predicate.md +22 -0
  68. package/docs/Node.md +38 -0
  69. package/docs/Node1.md +38 -0
  70. package/docs/PlanApi.md +132 -0
  71. package/docs/PlanGet200Response.md +26 -0
  72. package/docs/PlanPost201Response.md +20 -0
  73. package/docs/ResponseFormat.md +12 -0
  74. package/docs/RunsApi.md +260 -0
  75. package/docs/RunsGet200Response.md +26 -0
  76. package/docs/RunsGet200ResponseDataInner.md +42 -0
  77. package/docs/RunsIdGet200Response.md +20 -0
  78. package/docs/RunsIdGet200ResponseData.md +42 -0
  79. package/docs/RunsIdPatchRequest.md +28 -0
  80. package/docs/RunsTriggerPlanIdPostRequest.md +20 -0
  81. package/docs/TestPlanV1.md +38 -0
  82. package/docs/UnaryPredicate.md +18 -0
  83. package/docs/Wait.md +24 -0
  84. package/docs/Wait1.md +24 -0
  85. package/git_push.sh +57 -0
  86. package/index.ts +18 -0
  87. package/package.json +33 -0
  88. package/scripts/generate_sdk.sh +55 -0
  89. package/tsconfig.esm.json +7 -0
  90. package/tsconfig.json +18 -0
@@ -0,0 +1,30 @@
1
+ # BinaryPredicateOperator
2
+
3
+
4
+ ## Enum
5
+
6
+ * `Equal` (value: `'EQUAL'`)
7
+
8
+ * `NotEqual` (value: `'NOT_EQUAL'`)
9
+
10
+ * `GreaterThan` (value: `'GREATER_THAN'`)
11
+
12
+ * `LessThan` (value: `'LESS_THAN'`)
13
+
14
+ * `GreaterThanOrEqual` (value: `'GREATER_THAN_OR_EQUAL'`)
15
+
16
+ * `LessThanOrEqual` (value: `'LESS_THAN_OR_EQUAL'`)
17
+
18
+ * `Contains` (value: `'CONTAINS'`)
19
+
20
+ * `NotContains` (value: `'NOT_CONTAINS'`)
21
+
22
+ * `StartsWith` (value: `'STARTS_WITH'`)
23
+
24
+ * `EndsWith` (value: `'ENDS_WITH'`)
25
+
26
+ * `NotStartsWith` (value: `'NOT_STARTS_WITH'`)
27
+
28
+ * `NotEndsWith` (value: `'NOT_ENDS_WITH'`)
29
+
30
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,330 @@
1
+ # ConfigApi
2
+
3
+ All URIs are relative to *http://localhost:3000*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**configGet**](#configget) | **GET** /config/ | |
8
+ |[**configOrganizationIdEnvironmentTargetsTargetKeyDelete**](#configorganizationidenvironmenttargetstargetkeydelete) | **DELETE** /config/{organizationId}/{environment}/targets/{targetKey} | |
9
+ |[**configOrganizationIdEnvironmentTargetsTargetKeyGet**](#configorganizationidenvironmenttargetstargetkeyget) | **GET** /config/{organizationId}/{environment}/targets/{targetKey} | |
10
+ |[**configOrganizationIdEnvironmentTargetsTargetKeyPut**](#configorganizationidenvironmenttargetstargetkeyput) | **PUT** /config/{organizationId}/{environment}/targets/{targetKey} | |
11
+ |[**configSingleGet**](#configsingleget) | **GET** /config/single | |
12
+
13
+ # **configGet**
14
+ > ConfigGet200Response configGet()
15
+
16
+
17
+ ### Example
18
+
19
+ ```typescript
20
+ import {
21
+ ConfigApi,
22
+ Configuration
23
+ } from 'griffin-hub-sdk';
24
+
25
+ const configuration = new Configuration();
26
+ const apiInstance = new ConfigApi(configuration);
27
+
28
+ let organizationId: string; // (optional) (default to undefined)
29
+ let environment: string; // (optional) (default to undefined)
30
+
31
+ const { status, data } = await apiInstance.configGet(
32
+ organizationId,
33
+ environment
34
+ );
35
+ ```
36
+
37
+ ### Parameters
38
+
39
+ |Name | Type | Description | Notes|
40
+ |------------- | ------------- | ------------- | -------------|
41
+ | **organizationId** | [**string**] | | (optional) defaults to undefined|
42
+ | **environment** | [**string**] | | (optional) defaults to undefined|
43
+
44
+
45
+ ### Return type
46
+
47
+ **ConfigGet200Response**
48
+
49
+ ### Authorization
50
+
51
+ No authorization required
52
+
53
+ ### HTTP request headers
54
+
55
+ - **Content-Type**: Not defined
56
+ - **Accept**: application/json
57
+
58
+
59
+ ### HTTP response details
60
+ | Status code | Description | Response headers |
61
+ |-------------|-------------|------------------|
62
+ |**200** | Default Response | - |
63
+ |**400** | Default Response | - |
64
+ |**401** | Default Response | - |
65
+ |**403** | Default Response | - |
66
+ |**404** | Default Response | - |
67
+ |**500** | Default Response | - |
68
+ |**502** | Default Response | - |
69
+ |**503** | Default Response | - |
70
+ |**504** | Default Response | - |
71
+
72
+ [[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)
73
+
74
+ # **configOrganizationIdEnvironmentTargetsTargetKeyDelete**
75
+ > configOrganizationIdEnvironmentTargetsTargetKeyDelete()
76
+
77
+
78
+ ### Example
79
+
80
+ ```typescript
81
+ import {
82
+ ConfigApi,
83
+ Configuration
84
+ } from 'griffin-hub-sdk';
85
+
86
+ const configuration = new Configuration();
87
+ const apiInstance = new ConfigApi(configuration);
88
+
89
+ let organizationId: string; // (default to undefined)
90
+ let environment: string; // (default to undefined)
91
+ let targetKey: string; // (default to undefined)
92
+
93
+ const { status, data } = await apiInstance.configOrganizationIdEnvironmentTargetsTargetKeyDelete(
94
+ organizationId,
95
+ environment,
96
+ targetKey
97
+ );
98
+ ```
99
+
100
+ ### Parameters
101
+
102
+ |Name | Type | Description | Notes|
103
+ |------------- | ------------- | ------------- | -------------|
104
+ | **organizationId** | [**string**] | | defaults to undefined|
105
+ | **environment** | [**string**] | | defaults to undefined|
106
+ | **targetKey** | [**string**] | | defaults to undefined|
107
+
108
+
109
+ ### Return type
110
+
111
+ void (empty response body)
112
+
113
+ ### Authorization
114
+
115
+ No authorization required
116
+
117
+ ### HTTP request headers
118
+
119
+ - **Content-Type**: Not defined
120
+ - **Accept**: application/json
121
+
122
+
123
+ ### HTTP response details
124
+ | Status code | Description | Response headers |
125
+ |-------------|-------------|------------------|
126
+ |**204** | Default Response | - |
127
+ |**400** | Default Response | - |
128
+ |**401** | Default Response | - |
129
+ |**403** | Default Response | - |
130
+ |**404** | Default Response | - |
131
+ |**500** | Default Response | - |
132
+ |**502** | Default Response | - |
133
+ |**503** | Default Response | - |
134
+ |**504** | Default Response | - |
135
+
136
+ [[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)
137
+
138
+ # **configOrganizationIdEnvironmentTargetsTargetKeyGet**
139
+ > ConfigOrganizationIdEnvironmentTargetsTargetKeyGet200Response configOrganizationIdEnvironmentTargetsTargetKeyGet()
140
+
141
+
142
+ ### Example
143
+
144
+ ```typescript
145
+ import {
146
+ ConfigApi,
147
+ Configuration
148
+ } from 'griffin-hub-sdk';
149
+
150
+ const configuration = new Configuration();
151
+ const apiInstance = new ConfigApi(configuration);
152
+
153
+ let organizationId: string; // (default to undefined)
154
+ let environment: string; // (default to undefined)
155
+ let targetKey: string; // (default to undefined)
156
+
157
+ const { status, data } = await apiInstance.configOrganizationIdEnvironmentTargetsTargetKeyGet(
158
+ organizationId,
159
+ environment,
160
+ targetKey
161
+ );
162
+ ```
163
+
164
+ ### Parameters
165
+
166
+ |Name | Type | Description | Notes|
167
+ |------------- | ------------- | ------------- | -------------|
168
+ | **organizationId** | [**string**] | | defaults to undefined|
169
+ | **environment** | [**string**] | | defaults to undefined|
170
+ | **targetKey** | [**string**] | | defaults to undefined|
171
+
172
+
173
+ ### Return type
174
+
175
+ **ConfigOrganizationIdEnvironmentTargetsTargetKeyGet200Response**
176
+
177
+ ### Authorization
178
+
179
+ No authorization required
180
+
181
+ ### HTTP request headers
182
+
183
+ - **Content-Type**: Not defined
184
+ - **Accept**: application/json
185
+
186
+
187
+ ### HTTP response details
188
+ | Status code | Description | Response headers |
189
+ |-------------|-------------|------------------|
190
+ |**200** | Default Response | - |
191
+ |**400** | Default Response | - |
192
+ |**401** | Default Response | - |
193
+ |**403** | Default Response | - |
194
+ |**404** | Default Response | - |
195
+ |**500** | Default Response | - |
196
+ |**502** | Default Response | - |
197
+ |**503** | Default Response | - |
198
+ |**504** | Default Response | - |
199
+
200
+ [[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)
201
+
202
+ # **configOrganizationIdEnvironmentTargetsTargetKeyPut**
203
+ > ConfigOrganizationIdEnvironmentTargetsTargetKeyPut200Response configOrganizationIdEnvironmentTargetsTargetKeyPut(configOrganizationIdEnvironmentTargetsTargetKeyPutRequest)
204
+
205
+
206
+ ### Example
207
+
208
+ ```typescript
209
+ import {
210
+ ConfigApi,
211
+ Configuration,
212
+ ConfigOrganizationIdEnvironmentTargetsTargetKeyPutRequest
213
+ } from 'griffin-hub-sdk';
214
+
215
+ const configuration = new Configuration();
216
+ const apiInstance = new ConfigApi(configuration);
217
+
218
+ let organizationId: string; // (default to undefined)
219
+ let environment: string; // (default to undefined)
220
+ let targetKey: string; // (default to undefined)
221
+ let configOrganizationIdEnvironmentTargetsTargetKeyPutRequest: ConfigOrganizationIdEnvironmentTargetsTargetKeyPutRequest; //
222
+
223
+ const { status, data } = await apiInstance.configOrganizationIdEnvironmentTargetsTargetKeyPut(
224
+ organizationId,
225
+ environment,
226
+ targetKey,
227
+ configOrganizationIdEnvironmentTargetsTargetKeyPutRequest
228
+ );
229
+ ```
230
+
231
+ ### Parameters
232
+
233
+ |Name | Type | Description | Notes|
234
+ |------------- | ------------- | ------------- | -------------|
235
+ | **configOrganizationIdEnvironmentTargetsTargetKeyPutRequest** | **ConfigOrganizationIdEnvironmentTargetsTargetKeyPutRequest**| | |
236
+ | **organizationId** | [**string**] | | defaults to undefined|
237
+ | **environment** | [**string**] | | defaults to undefined|
238
+ | **targetKey** | [**string**] | | defaults to undefined|
239
+
240
+
241
+ ### Return type
242
+
243
+ **ConfigOrganizationIdEnvironmentTargetsTargetKeyPut200Response**
244
+
245
+ ### Authorization
246
+
247
+ No authorization required
248
+
249
+ ### HTTP request headers
250
+
251
+ - **Content-Type**: application/json
252
+ - **Accept**: application/json
253
+
254
+
255
+ ### HTTP response details
256
+ | Status code | Description | Response headers |
257
+ |-------------|-------------|------------------|
258
+ |**200** | Default Response | - |
259
+ |**400** | Default Response | - |
260
+ |**401** | Default Response | - |
261
+ |**403** | Default Response | - |
262
+ |**404** | Default Response | - |
263
+ |**500** | Default Response | - |
264
+ |**502** | Default Response | - |
265
+ |**503** | Default Response | - |
266
+ |**504** | Default Response | - |
267
+
268
+ [[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)
269
+
270
+ # **configSingleGet**
271
+ > ConfigOrganizationIdEnvironmentTargetsTargetKeyPut200Response configSingleGet()
272
+
273
+
274
+ ### Example
275
+
276
+ ```typescript
277
+ import {
278
+ ConfigApi,
279
+ Configuration
280
+ } from 'griffin-hub-sdk';
281
+
282
+ const configuration = new Configuration();
283
+ const apiInstance = new ConfigApi(configuration);
284
+
285
+ let organizationId: string; // (default to undefined)
286
+ let environment: string; // (default to undefined)
287
+
288
+ const { status, data } = await apiInstance.configSingleGet(
289
+ organizationId,
290
+ environment
291
+ );
292
+ ```
293
+
294
+ ### Parameters
295
+
296
+ |Name | Type | Description | Notes|
297
+ |------------- | ------------- | ------------- | -------------|
298
+ | **organizationId** | [**string**] | | defaults to undefined|
299
+ | **environment** | [**string**] | | defaults to undefined|
300
+
301
+
302
+ ### Return type
303
+
304
+ **ConfigOrganizationIdEnvironmentTargetsTargetKeyPut200Response**
305
+
306
+ ### Authorization
307
+
308
+ No authorization required
309
+
310
+ ### HTTP request headers
311
+
312
+ - **Content-Type**: Not defined
313
+ - **Accept**: application/json
314
+
315
+
316
+ ### HTTP response details
317
+ | Status code | Description | Response headers |
318
+ |-------------|-------------|------------------|
319
+ |**200** | Default Response | - |
320
+ |**400** | Default Response | - |
321
+ |**401** | Default Response | - |
322
+ |**403** | Default Response | - |
323
+ |**404** | Default Response | - |
324
+ |**500** | Default Response | - |
325
+ |**502** | Default Response | - |
326
+ |**503** | Default Response | - |
327
+ |**504** | Default Response | - |
328
+
329
+ [[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)
330
+
@@ -0,0 +1,20 @@
1
+ # ConfigGet200Response
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **data** | [**Array<ConfigOrganizationIdEnvironmentTargetsTargetKeyPut200ResponseData>**](ConfigOrganizationIdEnvironmentTargetsTargetKeyPut200ResponseData.md) | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { ConfigGet200Response } from 'griffin-hub-sdk';
14
+
15
+ const instance: ConfigGet200Response = {
16
+ data,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # ConfigOrganizationIdEnvironmentTargetsTargetKeyGet200Response
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **data** | [**ConfigOrganizationIdEnvironmentTargetsTargetKeyGet200ResponseData**](ConfigOrganizationIdEnvironmentTargetsTargetKeyGet200ResponseData.md) | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { ConfigOrganizationIdEnvironmentTargetsTargetKeyGet200Response } from 'griffin-hub-sdk';
14
+
15
+ const instance: ConfigOrganizationIdEnvironmentTargetsTargetKeyGet200Response = {
16
+ data,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # ConfigOrganizationIdEnvironmentTargetsTargetKeyGet200ResponseData
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **baseUrl** | **string** | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { ConfigOrganizationIdEnvironmentTargetsTargetKeyGet200ResponseData } from 'griffin-hub-sdk';
14
+
15
+ const instance: ConfigOrganizationIdEnvironmentTargetsTargetKeyGet200ResponseData = {
16
+ baseUrl,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # ConfigOrganizationIdEnvironmentTargetsTargetKeyPut200Response
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **data** | [**ConfigOrganizationIdEnvironmentTargetsTargetKeyPut200ResponseData**](ConfigOrganizationIdEnvironmentTargetsTargetKeyPut200ResponseData.md) | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { ConfigOrganizationIdEnvironmentTargetsTargetKeyPut200Response } from 'griffin-hub-sdk';
14
+
15
+ const instance: ConfigOrganizationIdEnvironmentTargetsTargetKeyPut200Response = {
16
+ data,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,30 @@
1
+ # ConfigOrganizationIdEnvironmentTargetsTargetKeyPut200ResponseData
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [default to undefined]
9
+ **organizationId** | **string** | | [default to undefined]
10
+ **environment** | **string** | | [default to undefined]
11
+ **targets** | **{ [key: string]: string; }** | | [default to undefined]
12
+ **createdAt** | **string** | | [default to undefined]
13
+ **updatedAt** | **string** | | [default to undefined]
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import { ConfigOrganizationIdEnvironmentTargetsTargetKeyPut200ResponseData } from 'griffin-hub-sdk';
19
+
20
+ const instance: ConfigOrganizationIdEnvironmentTargetsTargetKeyPut200ResponseData = {
21
+ id,
22
+ organizationId,
23
+ environment,
24
+ targets,
25
+ createdAt,
26
+ updatedAt,
27
+ };
28
+ ```
29
+
30
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # ConfigOrganizationIdEnvironmentTargetsTargetKeyPutRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **baseUrl** | **string** | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { ConfigOrganizationIdEnvironmentTargetsTargetKeyPutRequest } from 'griffin-hub-sdk';
14
+
15
+ const instance: ConfigOrganizationIdEnvironmentTargetsTargetKeyPutRequest = {
16
+ baseUrl,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,51 @@
1
+ # DefaultApi
2
+
3
+ All URIs are relative to *http://localhost:3000*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**rootGet**](#rootget) | **GET** / | |
8
+
9
+ # **rootGet**
10
+ > rootGet()
11
+
12
+
13
+ ### Example
14
+
15
+ ```typescript
16
+ import {
17
+ DefaultApi,
18
+ Configuration
19
+ } from 'griffin-hub-sdk';
20
+
21
+ const configuration = new Configuration();
22
+ const apiInstance = new DefaultApi(configuration);
23
+
24
+ const { status, data } = await apiInstance.rootGet();
25
+ ```
26
+
27
+ ### Parameters
28
+ This endpoint does not have any parameters.
29
+
30
+
31
+ ### Return type
32
+
33
+ void (empty response body)
34
+
35
+ ### Authorization
36
+
37
+ No authorization required
38
+
39
+ ### HTTP request headers
40
+
41
+ - **Content-Type**: Not defined
42
+ - **Accept**: Not defined
43
+
44
+
45
+ ### HTTP response details
46
+ | Status code | Description | Response headers |
47
+ |-------------|-------------|------------------|
48
+ |**200** | Default Response | - |
49
+
50
+ [[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)
51
+
package/docs/Edge.md ADDED
@@ -0,0 +1,22 @@
1
+ # Edge
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **from** | **string** | | [default to undefined]
9
+ **to** | **string** | | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { Edge } from 'griffin-hub-sdk';
15
+
16
+ const instance: Edge = {
17
+ from,
18
+ to,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/Edge1.md ADDED
@@ -0,0 +1,22 @@
1
+ # Edge1
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **from** | **string** | | [default to undefined]
9
+ **to** | **string** | | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { Edge1 } from 'griffin-hub-sdk';
15
+
16
+ const instance: Edge1 = {
17
+ from,
18
+ to,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,34 @@
1
+ # Endpoint
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [default to undefined]
9
+ **type** | **string** | | [default to undefined]
10
+ **method** | **string** | | [default to undefined]
11
+ **path** | **string** | | [default to undefined]
12
+ **base** | [**Endpoint1Base**](Endpoint1Base.md) | | [default to undefined]
13
+ **headers** | [**{ [key: string]: Endpoint1HeadersValue; }**](Endpoint1HeadersValue.md) | | [optional] [default to undefined]
14
+ **body** | **any** | | [optional] [default to undefined]
15
+ **response_format** | **string** | | [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { Endpoint } from 'griffin-hub-sdk';
21
+
22
+ const instance: Endpoint = {
23
+ id,
24
+ type,
25
+ method,
26
+ path,
27
+ base,
28
+ headers,
29
+ body,
30
+ response_format,
31
+ };
32
+ ```
33
+
34
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,34 @@
1
+ # Endpoint1
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [default to undefined]
9
+ **type** | **string** | | [default to undefined]
10
+ **method** | **string** | | [default to undefined]
11
+ **path** | **string** | | [default to undefined]
12
+ **base** | [**Endpoint1Base**](Endpoint1Base.md) | | [default to undefined]
13
+ **headers** | [**{ [key: string]: Endpoint1HeadersValue; }**](Endpoint1HeadersValue.md) | | [optional] [default to undefined]
14
+ **body** | **any** | | [optional] [default to undefined]
15
+ **response_format** | **string** | | [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { Endpoint1 } from 'griffin-hub-sdk';
21
+
22
+ const instance: Endpoint1 = {
23
+ id,
24
+ type,
25
+ method,
26
+ path,
27
+ base,
28
+ headers,
29
+ body,
30
+ response_format,
31
+ };
32
+ ```
33
+
34
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,22 @@
1
+ # Endpoint1Base
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **type** | **string** | | [default to undefined]
9
+ **key** | **string** | | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { Endpoint1Base } from 'griffin-hub-sdk';
15
+
16
+ const instance: Endpoint1Base = {
17
+ type,
18
+ key,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)