Skip to content

Commit 86a2782

Browse files
author
Ted Spence
committed
Added word wrap, which doesn't quite work correctly for markdown but is better than nothing
1 parent 02dd971 commit 86a2782

Some content is hidden

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

48 files changed

+2023
-815
lines changed

‎src/clients/activities_client.py‎

Lines changed: 66 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -22,28 +22,43 @@ def __init__(self, client: LockstepApi):
2222
self.client = client
2323

2424
"""
25-
Retrieves the Activity specified by this unique identifier, optionally including nested data sets.
26-
27-
An Activity contains information about work being done on a specific accounting task. You can use Activities to track information about who has been assigned a specific task, the current status of the task, the name and description given for the particular task, the priority of the task, and any amounts collected, paid, or credited for the task.
28-
25+
Retrieves the Activity specified by this unique identifier, optionally
26+
including nested data sets.
27+
28+
An Activity contains information about
29+
work being done on a specific accounting task. You can use Activities to
30+
track information about who has been assigned a specific task, the
31+
current status of the task, the name and description given for the
32+
particular task, the priority of the task, and any amounts collected,
33+
paid, or credited for the task.
2934
Parameters
3035
----------
3136
id : str
3237
The unique Lockstep Platform ID number of this Activity
3338
include : str
34-
To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Attachments, CustomFields, and Notes
39+
To fetch additional data on this object, specify the list of elements to
40+
retrieve. Available collections: Attachments, CustomFields, and Notes
3541
"""
3642
def retrieve_activity(self, id: str, include: str) -> LockstepResponse:
3743
path = f"/api/v1/Activities/{id}"
3844
return self.client.send_request("GET", path, None, {id: str, include: str})
3945

4046
"""
41-
Updates an activity that matches the specified id with the requested information.
42-
43-
The PATCH method allows you to change specific values on the object while leaving other values alone. As input you should supply a list of field names and new values. If you do not provide the name of a field, that field will remain unchanged. This allows you to ensure that you are only updating the specific fields desired.
44-
45-
An Activity contains information about work being done on a specific accounting task. You can use Activities to track information about who has been assigned a specific task, the current status of the task, the name and description given for the particular task, the priority of the task, and any amounts collected, paid, or credited for the task.
46-
47+
Updates an activity that matches the specified id with the requested
48+
information.
49+
50+
The PATCH method allows you to change specific values on
51+
the object while leaving other values alone. As input you should supply
52+
a list of field names and new values. If you do not provide the name of
53+
a field, that field will remain unchanged. This allows you to ensure
54+
that you are only updating the specific fields desired.
55+
56+
An Activity
57+
contains information about work being done on a specific accounting
58+
task. You can use Activities to track information about who has been
59+
assigned a specific task, the current status of the task, the name and
60+
description given for the particular task, the priority of the task, and
61+
any amounts collected, paid, or credited for the task.
4762
Parameters
4863
----------
4964
id : str
@@ -56,10 +71,14 @@ def update_activity(self, id: str, body: object) -> LockstepResponse:
5671
return self.client.send_request("PATCH", path, body, {id: str, body: object})
5772

5873
"""
59-
Delete the Activity referred to by this unique identifier.
60-
61-
An Activity contains information about work being done on a specific accounting task. You can use Activities to track information about who has been assigned a specific task, the current status of the task, the name and description given for the particular task, the priority of the task, and any amounts collected, paid, or credited for the task.
62-
74+
Delete the Activity referred to by this unique identifier.
75+
76+
An
77+
Activity contains information about work being done on a specific
78+
accounting task. You can use Activities to track information about who
79+
has been assigned a specific task, the current status of the task, the
80+
name and description given for the particular task, the priority of the
81+
task, and any amounts collected, paid, or credited for the task.
6382
Parameters
6483
----------
6584
id : str
@@ -70,10 +89,14 @@ def delete_activity(self, id: str) -> LockstepResponse:
7089
return self.client.send_request("DELETE", path, None, {id: str})
7190

7291
"""
73-
Creates one or more activities from a given model.
74-
75-
An Activity contains information about work being done on a specific accounting task. You can use Activities to track information about who has been assigned a specific task, the current status of the task, the name and description given for the particular task, the priority of the task, and any amounts collected, paid, or credited for the task.
76-
92+
Creates one or more activities from a given model.
93+
94+
An Activity
95+
contains information about work being done on a specific accounting
96+
task. You can use Activities to track information about who has been
97+
assigned a specific task, the current status of the task, the name and
98+
description given for the particular task, the priority of the task, and
99+
any amounts collected, paid, or credited for the task.
77100
Parameters
78101
----------
79102
body : list[ActivityModel]
@@ -84,24 +107,37 @@ def create_activities(self, body: list[ActivityModel]) -> LockstepResponse:
84107
return self.client.send_request("POST", path, body, {body: list[ActivityModel]})
85108

86109
"""
87-
Queries Activities for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
88-
89-
More information on querying can be found on the [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.
90-
91-
An Activity contains information about work being done on a specific accounting task. You can use Activities to track information about who has been assigned a specific task, the current status of the task, the name and description given for the particular task, the priority of the task, and any amounts collected, paid, or credited for the task.
92-
110+
Queries Activities for this account using the specified filtering,
111+
sorting, nested fetch, and pagination rules requested.
112+
113+
More
114+
information on querying can be found on the [Searchlight Query
115+
Language](https://developer.lockstep.io/docs/querying-with-searchlight)
116+
page on the Lockstep Developer website.
117+
118+
An Activity contains
119+
information about work being done on a specific accounting task. You can
120+
use Activities to track information about who has been assigned a
121+
specific task, the current status of the task, the name and description
122+
given for the particular task, the priority of the task, and any amounts
123+
collected, paid, or credited for the task.
93124
Parameters
94125
----------
95126
filter : str
96-
The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
127+
The filter for this query. See [Searchlight Query
128+
Language](https://developer.lockstep.io/docs/querying-with-searchlight)
97129
include : str
98-
To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Attachments, CustomFields, and Notes
130+
To fetch additional data on this object, specify the list of elements to
131+
retrieve. Available collections: Attachments, CustomFields, and Notes
99132
order : str
100-
The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
133+
The sort order for this query. See See [Searchlight Query
134+
Language](https://developer.lockstep.io/docs/querying-with-searchlight)
101135
pageSize : int
102-
The page size for results (default 200). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
136+
The page size for results (default 200). See [Searchlight Query
137+
Language](https://developer.lockstep.io/docs/querying-with-searchlight)
103138
pageNumber : int
104-
The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
139+
The page number for results (default 0). See [Searchlight Query
140+
Language](https://developer.lockstep.io/docs/querying-with-searchlight)
105141
"""
106142
def query_activities(self, filter: str, include: str, order: str, pageSize: int, pageNumber: int) -> LockstepResponse:
107143
path = f"/api/v1/Activities/query"

‎src/clients/apikeys_client.py‎

Lines changed: 58 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -22,26 +22,45 @@ def __init__(self, client: LockstepApi):
2222
self.client = client
2323

2424
"""
25-
Retrieves the API Key with this identifier.
26-
27-
An API Key is an authentication token that you may use with the Lockstep API. Because API Keys do not have an expiration date, they are well suited for unattended processes. Each API Key is associated with a user, and may be revoked to prevent it from accessing the Lockstep API. When you create an API Key, make sure to save the value in a secure location. Lockstep cannot retrieve an API Key once it is created. For more information, see [API Keys](https://developer.lockstep.io/docs/api-keys).
28-
25+
Retrieves the API Key with this identifier.
26+
27+
An API Key is an
28+
authentication token that you may use with the Lockstep API. Because API
29+
Keys do not have an expiration date, they are well suited for unattended
30+
processes. Each API Key is associated with a user, and may be revoked to
31+
prevent it from accessing the Lockstep API. When you create an API Key,
32+
make sure to save the value in a secure location. Lockstep cannot
33+
retrieve an API Key once it is created. For more information, see [API
34+
Keys](https://developer.lockstep.io/docs/api-keys).
2935
Parameters
3036
----------
3137
id : str
3238
The unique ID number of the API Key to retrieve
3339
include : str
34-
To fetch additional data on this object, specify the list of elements to retrieve. No collections are currently available but may be offered in the future.
40+
To fetch additional data on this object, specify the list of elements to
41+
retrieve. No collections are currently available but may be offered in
42+
the future.
3543
"""
3644
def retrieve_api_key(self, id: str, include: str) -> LockstepResponse:
3745
path = f"/api/v1/ApiKeys/{id}"
3846
return self.client.send_request("GET", path, None, {id: str, include: str})
3947

4048
"""
41-
Immediately revokes the API Key with the specified id so it cannot be used to call the API. The Lockstep Platform guarantees that revocation will be received by all servers within five minutes of revocation. API calls made using this API key after the revocation will fail. A revoked API Key cannot be un-revoked and may be removed 60 days after revocation.
42-
43-
An API Key is an authentication token that you may use with the Lockstep API. Because API Keys do not have an expiration date, they are well suited for unattended processes. Each API Key is associated with a user, and may be revoked to prevent it from accessing the Lockstep API. When you create an API Key, make sure to save the value in a secure location. Lockstep cannot retrieve an API Key once it is created. For more information, see [API Keys](https://developer.lockstep.io/docs/api-keys).
44-
49+
Immediately revokes the API Key with the specified id so it cannot be
50+
used to call the API. The Lockstep Platform guarantees that revocation
51+
will be received by all servers within five minutes of revocation. API
52+
calls made using this API key after the revocation will fail. A revoked
53+
API Key cannot be un-revoked and may be removed 60 days after
54+
revocation.
55+
56+
An API Key is an authentication token that you may use
57+
with the Lockstep API. Because API Keys do not have an expiration date,
58+
they are well suited for unattended processes. Each API Key is
59+
associated with a user, and may be revoked to prevent it from accessing
60+
the Lockstep API. When you create an API Key, make sure to save the
61+
value in a secure location. Lockstep cannot retrieve an API Key once it
62+
is created. For more information, see [API
63+
Keys](https://developer.lockstep.io/docs/api-keys).
4564
Parameters
4665
----------
4766
id : str
@@ -52,10 +71,16 @@ def revoke_api_key(self, id: str) -> LockstepResponse:
5271
return self.client.send_request("DELETE", path, None, {id: str})
5372

5473
"""
55-
Creates an API key with the specified name.
56-
57-
An API Key is an authentication token that you may use with the Lockstep API. Because API Keys do not have an expiration date, they are well suited for unattended processes. Each API Key is associated with a user, and may be revoked to prevent it from accessing the Lockstep API. When you create an API Key, make sure to save the value in a secure location. Lockstep cannot retrieve an API Key once it is created. For more information, see [API Keys](https://developer.lockstep.io/docs/api-keys).
58-
74+
Creates an API key with the specified name.
75+
76+
An API Key is an
77+
authentication token that you may use with the Lockstep API. Because API
78+
Keys do not have an expiration date, they are well suited for unattended
79+
processes. Each API Key is associated with a user, and may be revoked to
80+
prevent it from accessing the Lockstep API. When you create an API Key,
81+
make sure to save the value in a secure location. Lockstep cannot
82+
retrieve an API Key once it is created. For more information, see [API
83+
Keys](https://developer.lockstep.io/docs/api-keys).
5984
Parameters
6085
----------
6186
body : ApiKeyModel
@@ -66,20 +91,33 @@ def create_api_key(self, body: ApiKeyModel) -> LockstepResponse:
6691
return self.client.send_request("POST", path, body, {body: ApiKeyModel})
6792

6893
"""
69-
Queries API Keys for this user using the specified filtering, sorting, nested fetch, and pagination rules requested. An API Key is an authentication token that you may use with the Lockstep API. Because API Keys do not have an expiration date, they are well suited for unattended processes. Each API Key is associated with a user, and may be revoked to prevent it from accessing the Lockstep API. When you create an API Key, make sure to save the value in a secure location. Lockstep cannot retrieve an API Key once it is created. For more information, see [API Keys](https://developer.lockstep.io/docs/api-keys).
70-
94+
Queries API Keys for this user using the specified filtering, sorting,
95+
nested fetch, and pagination rules requested. An API Key is an
96+
authentication token that you may use with the Lockstep API. Because API
97+
Keys do not have an expiration date, they are well suited for unattended
98+
processes. Each API Key is associated with a user, and may be revoked to
99+
prevent it from accessing the Lockstep API. When you create an API Key,
100+
make sure to save the value in a secure location. Lockstep cannot
101+
retrieve an API Key once it is created. For more information, see [API
102+
Keys](https://developer.lockstep.io/docs/api-keys).
71103
Parameters
72104
----------
73105
filter : str
74-
The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
106+
The filter for this query. See [Searchlight Query
107+
Language](https://developer.lockstep.io/docs/querying-with-searchlight)
75108
include : str
76-
To fetch additional data on this object, specify the list of elements to retrieve. No collections are currently available but may be offered in the future.
109+
To fetch additional data on this object, specify the list of elements to
110+
retrieve. No collections are currently available but may be offered in
111+
the future.
77112
order : str
78-
The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
113+
The sort order for this query. See See [Searchlight Query
114+
Language](https://developer.lockstep.io/docs/querying-with-searchlight)
79115
pageSize : int
80-
The page size for results (default 200). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
116+
The page size for results (default 200). See [Searchlight Query
117+
Language](https://developer.lockstep.io/docs/querying-with-searchlight)
81118
pageNumber : int
82-
The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
119+
The page number for results (default 0). See [Searchlight Query
120+
Language](https://developer.lockstep.io/docs/querying-with-searchlight)
83121
"""
84122
def query_api_keys(self, filter: str, include: str, order: str, pageSize: int, pageNumber: int) -> LockstepResponse:
85123
path = f"/api/v1/ApiKeys/query"

0 commit comments

Comments
 (0)