Skip to content

Commit 26d13d0

Browse files
authored
Merge pull request #1 from Factern/improve-documentation-and-inheritance
Improve documentation and inheritance
2 parents 03703aa + c047a92 commit 26d13d0

File tree

443 files changed

+14691
-16267
lines changed

Some content is hidden

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

443 files changed

+14691
-16267
lines changed

README.md

Lines changed: 80 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
## Python Client for Factern API v2
55

66
- API version: 2.0.0
7-
- Package version: 1.0.5
7+
- Package version: 1.0.6
88
For more information, please visit [https://next.factern.com/company/contact](https://next.factern.com/company/contact)
99

1010
## Requirements.
@@ -57,13 +57,13 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN'
5757

5858
# create an instance of the API class
5959
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
60-
body = factern_client.CreateMemberRequest() # CreateMemberRequest |
6160
login = 'login_example' # str | (optional)
6261
representing = 'representing_example' # str | (optional)
62+
create_member_request = factern_client.CreateMemberRequest() # CreateMemberRequest | (optional)
6363

6464
try:
6565
# Create Member
66-
api_response = api_instance.add_member(body, login=login, representing=representing)
66+
api_response = api_instance.add_member(login=login, representing=representing, create_member_request=create_member_request)
6767
pprint(api_response)
6868
except ApiException as e:
6969
print("Exception when calling FactsApi->add_member: %s\n" % e)
@@ -118,149 +118,149 @@ Class | Method | HTTP request | Description
118118
## Documentation For Models
119119

120120
- [Account](docs/Account.md)
121+
- [AddLabelRequest](docs/AddLabelRequest.md)
122+
- [AddLabelResponse](docs/AddLabelResponse.md)
123+
- [AddStatementRequest](docs/AddStatementRequest.md)
124+
- [AddStatementResponse](docs/AddStatementResponse.md)
121125
- [Agent](docs/Agent.md)
126+
- [Alias](docs/Alias.md)
122127
- [AliasNode](docs/AliasNode.md)
123128
- [ApiEndpoint](docs/ApiEndpoint.md)
129+
- [Application](docs/Application.md)
124130
- [ApplicationNode](docs/ApplicationNode.md)
125131
- [BaseRequest](docs/BaseRequest.md)
126132
- [BaseResponse](docs/BaseResponse.md)
133+
- [Bid](docs/Bid.md)
127134
- [BidNode](docs/BidNode.md)
128135
- [Cost](docs/Cost.md)
129-
- [DeleteResponse](docs/DeleteResponse.md)
130-
- [DeletedItem](docs/DeletedItem.md)
131-
- [DeletedStatusItem](docs/DeletedStatusItem.md)
132-
- [DescribeResponse](docs/DescribeResponse.md)
133-
- [DomainNode](docs/DomainNode.md)
134-
- [EntityListResponse](docs/EntityListResponse.md)
135-
- [EntityNode](docs/EntityNode.md)
136-
- [ExternalDataUsage](docs/ExternalDataUsage.md)
137-
- [FactCount](docs/FactCount.md)
138-
- [FieldNode](docs/FieldNode.md)
139-
- [FieldStoreValues](docs/FieldStoreValues.md)
140-
- [FilterNode](docs/FilterNode.md)
141-
- [FilterStatement](docs/FilterStatement.md)
142-
- [GasCost](docs/GasCost.md)
143-
- [GroupNode](docs/GroupNode.md)
144-
- [HttpHeader](docs/HttpHeader.md)
145-
- [InformationListResponse](docs/InformationListResponse.md)
146-
- [InformationNode](docs/InformationNode.md)
147-
- [InterfaceNode](docs/InterfaceNode.md)
148-
- [LabelListMemberNode](docs/LabelListMemberNode.md)
149-
- [LabelListNode](docs/LabelListNode.md)
150-
- [LabelStatement](docs/LabelStatement.md)
151-
- [ListCriteria](docs/ListCriteria.md)
152-
- [LoginNode](docs/LoginNode.md)
153-
- [MemberNode](docs/MemberNode.md)
154-
- [MirrorNode](docs/MirrorNode.md)
155-
- [NamedNode](docs/NamedNode.md)
156-
- [NodeListing](docs/NodeListing.md)
157-
- [PermissionAction](docs/PermissionAction.md)
158-
- [PermissionEffect](docs/PermissionEffect.md)
159-
- [PermissionNode](docs/PermissionNode.md)
160-
- [PermissionPolicyDocument](docs/PermissionPolicyDocument.md)
161-
- [PriceDetails](docs/PriceDetails.md)
162-
- [PriceNode](docs/PriceNode.md)
163-
- [ReadInformationResponse](docs/ReadInformationResponse.md)
164-
- [ReadItem](docs/ReadItem.md)
165-
- [ReadResponse](docs/ReadResponse.md)
166-
- [ReadStatusItem](docs/ReadStatusItem.md)
167-
- [ScopeNode](docs/ScopeNode.md)
168-
- [SearchAliasResponse](docs/SearchAliasResponse.md)
169-
- [Searches](docs/Searches.md)
170-
- [SettleAccountResponse](docs/SettleAccountResponse.md)
171-
- [StandardNode](docs/StandardNode.md)
172-
- [StandardNodeResponse](docs/StandardNodeResponse.md)
173-
- [StatementStatement](docs/StatementStatement.md)
174-
- [Summary](docs/Summary.md)
175-
- [TemplateNode](docs/TemplateNode.md)
176-
- [TokenPayment](docs/TokenPayment.md)
177-
- [TransformElement](docs/TransformElement.md)
178-
- [WatchEventNode](docs/WatchEventNode.md)
179-
- [WatchNode](docs/WatchNode.md)
180-
- [WriteItem](docs/WriteItem.md)
181-
- [WriteResponse](docs/WriteResponse.md)
182-
- [AddLabelRequest](docs/AddLabelRequest.md)
183-
- [AddLabelResponse](docs/AddLabelResponse.md)
184-
- [AddStatementRequest](docs/AddStatementRequest.md)
185-
- [AddStatementResponse](docs/AddStatementResponse.md)
186-
- [Alias](docs/Alias.md)
187-
- [Application](docs/Application.md)
188-
- [Bid](docs/Bid.md)
189136
- [CreateAliasRequest](docs/CreateAliasRequest.md)
190137
- [CreateAliasResponse](docs/CreateAliasResponse.md)
138+
- [CreateApplicationRequest](docs/CreateApplicationRequest.md)
191139
- [CreateApplicationResponse](docs/CreateApplicationResponse.md)
192140
- [CreateBidRequest](docs/CreateBidRequest.md)
193141
- [CreateBidResponse](docs/CreateBidResponse.md)
194142
- [CreateChildRequest](docs/CreateChildRequest.md)
143+
- [CreateDomainRequest](docs/CreateDomainRequest.md)
195144
- [CreateDomainResponse](docs/CreateDomainResponse.md)
145+
- [CreateEntityRequest](docs/CreateEntityRequest.md)
196146
- [CreateEntityResponse](docs/CreateEntityResponse.md)
147+
- [CreateFieldRequest](docs/CreateFieldRequest.md)
197148
- [CreateFieldResponse](docs/CreateFieldResponse.md)
149+
- [CreateFilterRequest](docs/CreateFilterRequest.md)
198150
- [CreateFilterResponse](docs/CreateFilterResponse.md)
151+
- [CreateGroupRequest](docs/CreateGroupRequest.md)
199152
- [CreateGroupResponse](docs/CreateGroupResponse.md)
153+
- [CreateInformationRequest](docs/CreateInformationRequest.md)
200154
- [CreateInformationResponse](docs/CreateInformationResponse.md)
155+
- [CreateInterfaceRequest](docs/CreateInterfaceRequest.md)
201156
- [CreateInterfaceResponse](docs/CreateInterfaceResponse.md)
157+
- [CreateLabelListRequest](docs/CreateLabelListRequest.md)
202158
- [CreateLabelListResponse](docs/CreateLabelListResponse.md)
203159
- [CreateLoginRequest](docs/CreateLoginRequest.md)
204160
- [CreateLoginResponse](docs/CreateLoginResponse.md)
161+
- [CreateMemberRequest](docs/CreateMemberRequest.md)
205162
- [CreateMemberResponse](docs/CreateMemberResponse.md)
206163
- [CreateMirrorRequest](docs/CreateMirrorRequest.md)
207164
- [CreateMirrorResponse](docs/CreateMirrorResponse.md)
165+
- [CreateNamedRequest](docs/CreateNamedRequest.md)
208166
- [CreatePermissionRequest](docs/CreatePermissionRequest.md)
209167
- [CreatePermissionResponse](docs/CreatePermissionResponse.md)
210168
- [CreatePriceRequest](docs/CreatePriceRequest.md)
211169
- [CreatePriceResponse](docs/CreatePriceResponse.md)
170+
- [CreateScopeRequest](docs/CreateScopeRequest.md)
212171
- [CreateScopeResponse](docs/CreateScopeResponse.md)
172+
- [CreateTemplateRequest](docs/CreateTemplateRequest.md)
213173
- [CreateTemplateResponse](docs/CreateTemplateResponse.md)
214174
- [CreateWatchRequest](docs/CreateWatchRequest.md)
215175
- [CreateWatchResponse](docs/CreateWatchResponse.md)
216176
- [DeleteRequest](docs/DeleteRequest.md)
177+
- [DeleteResponse](docs/DeleteResponse.md)
178+
- [DeletedItem](docs/DeletedItem.md)
179+
- [DeletedStatusItem](docs/DeletedStatusItem.md)
217180
- [DescribeRequest](docs/DescribeRequest.md)
181+
- [DescribeResponse](docs/DescribeResponse.md)
218182
- [Domain](docs/Domain.md)
183+
- [DomainNode](docs/DomainNode.md)
219184
- [Entity](docs/Entity.md)
185+
- [EntityListResponse](docs/EntityListResponse.md)
186+
- [EntityNode](docs/EntityNode.md)
187+
- [ExternalDataUsage](docs/ExternalDataUsage.md)
188+
- [FactCount](docs/FactCount.md)
220189
- [Field](docs/Field.md)
190+
- [FieldNode](docs/FieldNode.md)
191+
- [FieldStoreValues](docs/FieldStoreValues.md)
221192
- [Filter](docs/Filter.md)
193+
- [FilterNode](docs/FilterNode.md)
194+
- [FilterStatement](docs/FilterStatement.md)
195+
- [GasCost](docs/GasCost.md)
222196
- [Group](docs/Group.md)
197+
- [GroupNode](docs/GroupNode.md)
198+
- [HttpHeader](docs/HttpHeader.md)
223199
- [Information](docs/Information.md)
200+
- [InformationListResponse](docs/InformationListResponse.md)
201+
- [InformationNode](docs/InformationNode.md)
224202
- [Interface](docs/Interface.md)
203+
- [InterfaceNode](docs/InterfaceNode.md)
225204
- [Label](docs/Label.md)
226205
- [LabelList](docs/LabelList.md)
227206
- [LabelListMember](docs/LabelListMember.md)
207+
- [LabelListMemberNode](docs/LabelListMemberNode.md)
208+
- [LabelListNode](docs/LabelListNode.md)
209+
- [LabelStatement](docs/LabelStatement.md)
210+
- [ListCriteria](docs/ListCriteria.md)
228211
- [Login](docs/Login.md)
212+
- [LoginNode](docs/LoginNode.md)
229213
- [Member](docs/Member.md)
214+
- [MemberNode](docs/MemberNode.md)
230215
- [Mirror](docs/Mirror.md)
216+
- [MirrorNode](docs/MirrorNode.md)
217+
- [NamedNode](docs/NamedNode.md)
231218
- [NodeIdRequest](docs/NodeIdRequest.md)
219+
- [NodeListing](docs/NodeListing.md)
232220
- [Permission](docs/Permission.md)
221+
- [PermissionAction](docs/PermissionAction.md)
222+
- [PermissionEffect](docs/PermissionEffect.md)
223+
- [PermissionNode](docs/PermissionNode.md)
224+
- [PermissionPolicyDocument](docs/PermissionPolicyDocument.md)
233225
- [Price](docs/Price.md)
226+
- [PriceDetails](docs/PriceDetails.md)
227+
- [PriceNode](docs/PriceNode.md)
234228
- [ReadInformationRequest](docs/ReadInformationRequest.md)
229+
- [ReadInformationResponse](docs/ReadInformationResponse.md)
230+
- [ReadItem](docs/ReadItem.md)
235231
- [ReadRequest](docs/ReadRequest.md)
232+
- [ReadResponse](docs/ReadResponse.md)
233+
- [ReadStatusItem](docs/ReadStatusItem.md)
236234
- [ReplaceFieldRequest](docs/ReplaceFieldRequest.md)
237235
- [ResetLoginCredentialsRequest](docs/ResetLoginCredentialsRequest.md)
238236
- [ResetLoginResponse](docs/ResetLoginResponse.md)
239237
- [Scope](docs/Scope.md)
238+
- [ScopeNode](docs/ScopeNode.md)
240239
- [SearchAliasRequest](docs/SearchAliasRequest.md)
240+
- [SearchAliasResponse](docs/SearchAliasResponse.md)
241241
- [SearchEntityRequest](docs/SearchEntityRequest.md)
242+
- [Searches](docs/Searches.md)
242243
- [SettleAccountRequest](docs/SettleAccountRequest.md)
244+
- [SettleAccountResponse](docs/SettleAccountResponse.md)
245+
- [StandardNode](docs/StandardNode.md)
246+
- [StandardNodeResponse](docs/StandardNodeResponse.md)
243247
- [Statement](docs/Statement.md)
248+
- [StatementStatement](docs/StatementStatement.md)
249+
- [Summary](docs/Summary.md)
244250
- [Template](docs/Template.md)
251+
- [TemplateNode](docs/TemplateNode.md)
252+
- [TokenPayment](docs/TokenPayment.md)
253+
- [TransformElement](docs/TransformElement.md)
245254
- [UpdateApplicationRequest](docs/UpdateApplicationRequest.md)
246255
- [UpdateApplicationResponse](docs/UpdateApplicationResponse.md)
256+
- [UpdateStatusRequest](docs/UpdateStatusRequest.md)
247257
- [Watch](docs/Watch.md)
248258
- [WatchEvent](docs/WatchEvent.md)
259+
- [WatchEventNode](docs/WatchEventNode.md)
260+
- [WatchNode](docs/WatchNode.md)
261+
- [WriteItem](docs/WriteItem.md)
249262
- [WriteRequest](docs/WriteRequest.md)
250-
- [CreateInformationRequest](docs/CreateInformationRequest.md)
251-
- [CreateMemberRequest](docs/CreateMemberRequest.md)
252-
- [CreateNamedRequest](docs/CreateNamedRequest.md)
253-
- [UpdateStatusRequest](docs/UpdateStatusRequest.md)
254-
- [CreateApplicationRequest](docs/CreateApplicationRequest.md)
255-
- [CreateDomainRequest](docs/CreateDomainRequest.md)
256-
- [CreateEntityRequest](docs/CreateEntityRequest.md)
257-
- [CreateFieldRequest](docs/CreateFieldRequest.md)
258-
- [CreateFilterRequest](docs/CreateFilterRequest.md)
259-
- [CreateGroupRequest](docs/CreateGroupRequest.md)
260-
- [CreateInterfaceRequest](docs/CreateInterfaceRequest.md)
261-
- [CreateLabelListRequest](docs/CreateLabelListRequest.md)
262-
- [CreateScopeRequest](docs/CreateScopeRequest.md)
263-
- [CreateTemplateRequest](docs/CreateTemplateRequest.md)
263+
- [WriteResponse](docs/WriteResponse.md)
264264

265265

266266
## Documentation For Authorization
@@ -272,11 +272,11 @@ Class | Method | HTTP request | Description
272272
- **Flow**: accessCode
273273
- **Authorization URL**: https://factern-test.eu.auth0.com/oauth/token
274274
- **Scopes**:
275-
- **profile**: Grants read and write access to administrative information
276-
- **openid**: Grants read and write access to administrative information
275+
- **address**: Grants read access
277276
- **email**: Grants read and write access to administrative information
277+
- **openid**: Grants read and write access to administrative information
278278
- **phone**: Grants write access
279-
- **address**: Grants read access
279+
- **profile**: Grants read and write access to administrative information
280280

281281

282282
## Author

docs/Account.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
1+
2+
13
# Account
24

35
## Properties
4-
Name | Type | Description | Notes
5-
------------ | ------------- | ------------- | -------------
6-
**balance** | **float** | |
76

8-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
7+
Name | Type | Required
8+
-------- | -------- | --------
9+
balance | float | required
10+
11+
12+
13+
14+
## Inheritance hierarchy
915

1016

17+
* [Account](Account.md)

docs/AddLabelRequest.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,20 @@
1+
2+
13
# AddLabelRequest
24

35
## Properties
4-
Name | Type | Description | Notes
5-
------------ | ------------- | ------------- | -------------
6-
**include_summary** | **bool** | | [optional]
7-
**target_node_id** | **str** | |
8-
**label_id** | **str** | |
96

10-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
7+
Name | Type | Required
8+
-------- | -------- | --------
9+
label_id | str | required
10+
target_node_id | str | required
11+
include_summary | bool | optional
12+
13+
14+
15+
16+
## Inheritance hierarchy
1117

1218

19+
* [AddLabelRequest](AddLabelRequest.md)
20+
* [BaseRequest](BaseRequest.md)

docs/AddLabelResponse.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
1+
2+
13
# AddLabelResponse
24

35
## Properties
4-
Name | Type | Description | Notes
5-
------------ | ------------- | ------------- | -------------
6-
**deleted** | **bool** | | [optional]
7-
**timestamp** | **float** | | [optional]
8-
**node_id** | **str** | | [optional]
9-
**agent** | [**Agent**](Agent.md) | | [optional]
10-
**summary** | [**Summary**](Summary.md) | | [optional]
11-
**batch_id** | **str** | | [optional]
12-
**fact_type** | **str** | | [optional]
13-
**parent_id** | **str** | | [optional]
146

15-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
7+
Name | Type | Required
8+
-------- | -------- | --------
9+
agent | [Agent](Agent.md) | optional
10+
batch_id | str | optional
11+
fact_type | str | optional
12+
node_id | str | optional
13+
parent_id | str | optional
14+
summary | [Summary](Summary.md) | optional
15+
timestamp | float | optional
16+
17+
18+
19+
20+
## Inheritance hierarchy
1621

1722

23+
* [AddLabelResponse](AddLabelResponse.md)
24+
* [BaseResponse](BaseResponse.md)

docs/AddStatementRequest.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,21 @@
1+
2+
13
# AddStatementRequest
24

35
## Properties
4-
Name | Type | Description | Notes
5-
------------ | ------------- | ------------- | -------------
6-
**include_summary** | **bool** | | [optional]
7-
**target_node_id** | **str** | |
8-
**action_qualifier_id** | **str** | | [optional]
9-
**action_id** | **str** | |
106

11-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
7+
Name | Type | Required
8+
-------- | -------- | --------
9+
action_id | str | required
10+
action_qualifier_id | str | optional
11+
target_node_id | str | required
12+
include_summary | bool | optional
13+
14+
15+
16+
17+
## Inheritance hierarchy
1218

1319

20+
* [AddStatementRequest](AddStatementRequest.md)
21+
* [BaseRequest](BaseRequest.md)

0 commit comments

Comments
 (0)