Skip to content

Commit 244bf40

Browse files
author
Ted Spence
committed
Better word wrap for markdown
1 parent 244f2b5 commit 244bf40

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

+1782
-1480
lines changed

‎src/clients/activities_client.py‎

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

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

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

6976
"""
70-
Delete the Activity referred to by this unique identifier. An Activity
71-
contains information about work being done on a specific accounting
72-
task. You can use Activities to track information about who has been
73-
assigned a specific task, the current status of the task, the name and
74-
description given for the particular task, the priority of the task, and
75-
any amounts collected, paid, or credited for the task.
77+
Delete the Activity referred to by this unique identifier.
78+
79+
An Activity contains information about work being done on a specific
80+
accounting task. You can use Activities to track information about
81+
who has been assigned a specific task, the current status of the
82+
task, the name and description given for the particular task, the
83+
priority of the task, and any amounts collected, paid, or credited
84+
for the task.
7685
7786
Parameters
7887
----------
@@ -84,12 +93,14 @@ def delete_activity(self, id: str) -> LockstepResponse:
8493
return self.client.send_request("DELETE", path, None, {id: str})
8594

8695
"""
87-
Creates one or more activities from a given model. An Activity contains
88-
information about work being done on a specific accounting task. You can
89-
use Activities to track information about who has been assigned a
90-
specific task, the current status of the task, the name and description
91-
given for the particular task, the priority of the task, and any amounts
92-
collected, paid, or credited for the task.
96+
Creates one or more activities from a given model.
97+
98+
An Activity contains information about work being done on a specific
99+
accounting task. You can use Activities to track information about
100+
who has been assigned a specific task, the current status of the
101+
task, the name and description given for the particular task, the
102+
priority of the task, and any amounts collected, paid, or credited
103+
for the task.
93104
94105
Parameters
95106
----------
@@ -101,33 +112,37 @@ def create_activities(self, body: list[ActivityModel]) -> LockstepResponse:
101112
return self.client.send_request("POST", path, body, {body: list[ActivityModel]})
102113

103114
"""
104-
Queries Activities for this account using the specified filtering,
105-
sorting, nested fetch, and pagination rules requested. More information
106-
on querying can be found on the [Searchlight Query
107-
Language](https://developer.lockstep.io/docs/querying-with-searchlight)
108-
page on the Lockstep Developer website. An Activity contains information
109-
about work being done on a specific accounting task. You can use
110-
Activities to track information about who has been assigned a specific
111-
task, the current status of the task, the name and description given for
112-
the particular task, the priority of the task, and any amounts
113-
collected, paid, or credited for the task.
115+
Queries Activities for this account using the specified filtering,
116+
sorting, nested fetch, and pagination rules requested.
117+
118+
More information on querying can be found on the [Searchlight Query
119+
Language](https://developer.lockstep.io/docs/querying-with-searchlight)
120+
page on the Lockstep Developer website.
121+
122+
An Activity contains information about work being done on a specific
123+
accounting task. You can use Activities to track information about
124+
who has been assigned a specific task, the current status of the
125+
task, the name and description given for the particular task, the
126+
priority of the task, and any amounts collected, paid, or credited
127+
for the task.
114128
115129
Parameters
116130
----------
117131
filter : str
118-
The filter for this query. See [Searchlight Query
132+
The filter for this query. See [Searchlight Query
119133
Language](https://developer.lockstep.io/docs/querying-with-searchlight)
120134
include : str
121-
To fetch additional data on this object, specify the list of elements to
122-
retrieve. Available collections: Attachments, CustomFields, and Notes
135+
To fetch additional data on this object, specify the list of
136+
elements to retrieve. Available collections: Attachments,
137+
CustomFields, and Notes
123138
order : str
124-
The sort order for this query. See See [Searchlight Query
139+
The sort order for this query. See See [Searchlight Query
125140
Language](https://developer.lockstep.io/docs/querying-with-searchlight)
126141
pageSize : int
127-
The page size for results (default 200). See [Searchlight Query
142+
The page size for results (default 200). See [Searchlight Query
128143
Language](https://developer.lockstep.io/docs/querying-with-searchlight)
129144
pageNumber : int
130-
The page number for results (default 0). See [Searchlight Query
145+
The page number for results (default 0). See [Searchlight Query
131146
Language](https://developer.lockstep.io/docs/querying-with-searchlight)
132147
"""
133148
def query_activities(self, filter: str, include: str, order: str, pageSize: int, pageNumber: int) -> LockstepResponse:

‎src/clients/apikeys_client.py‎

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

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

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

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

9096
"""
91-
Queries API Keys for this user using the specified filtering, sorting,
92-
nested fetch, and pagination rules requested. An API Key is an
93-
authentication token that you may use with the Lockstep API. Because API
94-
Keys do not have an expiration date, they are well suited for unattended
95-
processes. Each API Key is associated with a user, and may be revoked to
96-
prevent it from accessing the Lockstep API. When you create an API Key,
97-
make sure to save the value in a secure location. Lockstep cannot
98-
retrieve an API Key once it is created. For more information, see [API
97+
Queries API Keys for this user using the specified filtering,
98+
sorting, nested fetch, and pagination rules requested. An API Key is
99+
an authentication token that you may use with the Lockstep API.
100+
Because API Keys do not have an expiration date, they are well
101+
suited for unattended processes. Each API Key is associated with a
102+
user, and may be revoked to prevent it from accessing the Lockstep
103+
API. When you create an API Key, make sure to save the value in a
104+
secure location. Lockstep cannot retrieve an API Key once it is
105+
created. For more information, see [API
99106
Keys](https://developer.lockstep.io/docs/api-keys).
100107
101108
Parameters
102109
----------
103110
filter : str
104-
The filter for this query. See [Searchlight Query
111+
The filter for this query. See [Searchlight Query
105112
Language](https://developer.lockstep.io/docs/querying-with-searchlight)
106113
include : str
107-
To fetch additional data on this object, specify the list of elements to
108-
retrieve. No collections are currently available but may be offered in
109-
the future.
114+
To fetch additional data on this object, specify the list of
115+
elements to retrieve. No collections are currently available but
116+
may be offered in the future.
110117
order : str
111-
The sort order for this query. See See [Searchlight Query
118+
The sort order for this query. See See [Searchlight Query
112119
Language](https://developer.lockstep.io/docs/querying-with-searchlight)
113120
pageSize : int
114-
The page size for results (default 200). See [Searchlight Query
121+
The page size for results (default 200). See [Searchlight Query
115122
Language](https://developer.lockstep.io/docs/querying-with-searchlight)
116123
pageNumber : int
117-
The page number for results (default 0). See [Searchlight Query
124+
The page number for results (default 0). See [Searchlight Query
118125
Language](https://developer.lockstep.io/docs/querying-with-searchlight)
119126
"""
120127
def query_api_keys(self, filter: str, include: str, order: str, pageSize: int, pageNumber: int) -> LockstepResponse:

0 commit comments

Comments
 (0)