Fixes typos to markdown

Author: Ted Spence

src/clients/activities_client.py

@@ -22,15 +22,14 @@ def __init__(self, client: LockstepApi):
         self.client = client
 
     """
-Retrieves the Activity specified by this unique identifier, optionally
-    including nested data sets.
-
-An Activity contains information about
-    work being done on a specific accounting task. You can use Activities to
+    Retrieves the Activity specified by this unique identifier, optionally
+    including nested data sets. 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.
+
     Parameters
     ----------
     id : str
@@ -44,21 +43,18 @@ def retrieve_activity(self, id: str, include: str) -> LockstepResponse:
         return self.client.send_request("GET", path, None, {id: str, include: str})
 
     """
-Updates an activity that matches the specified id with the requested
-    information.
-
-The PATCH method allows you to change specific values on
+    Updates an activity that matches the specified id with the requested
+    information. 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.
-
-An Activity
+    that you are only updating the specific fields desired. 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.
+
     Parameters
     ----------
     id : str
@@ -71,14 +67,13 @@ def update_activity(self, id: str, body: object) -> LockstepResponse:
         return self.client.send_request("PATCH", path, body, {id: str, body: object})
 
     """
-Delete the Activity referred to by this unique identifier.
+    Delete the Activity referred to by this unique identifier. 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.
 
-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.
     Parameters
     ----------
     id : str
@@ -89,14 +84,13 @@ def delete_activity(self, id: str) -> LockstepResponse:
         return self.client.send_request("DELETE", path, None, {id: str})
 
     """
-Creates one or more activities from a given model.
+    Creates one or more activities from a given model. 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.
 
-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.
     Parameters
     ----------
     body : list[ActivityModel]
@@ -107,28 +101,25 @@ def create_activities(self, body: list[ActivityModel]) -> LockstepResponse:
         return self.client.send_request("POST", path, body, {body: list[ActivityModel]})
 
     """
-Queries Activities for this account using the specified filtering,
-    sorting, nested fetch, and pagination rules requested.
-
-More
-    information on querying can be found on the [Searchlight Query
+    Queries Activities for this account using the specified filtering,
+    sorting, nested fetch, and pagination rules requested. 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.
-
-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
+    page on the Lockstep Developer website. 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.
+
     Parameters
     ----------
     filter : str
         The filter for this query. See [Searchlight Query
         Language](https://developer.lockstep.io/docs/querying-with-searchlight)
     include : str
         To fetch additional data on this object, specify the list of elements to
-        retrieve.  Available collections: Attachments, CustomFields, and Notes
+        retrieve. Available collections: Attachments, CustomFields, and Notes
     order : str
         The sort order for this query. See See [Searchlight Query
         Language](https://developer.lockstep.io/docs/querying-with-searchlight)

src/clients/apikeys_client.py

@@ -22,16 +22,15 @@ def __init__(self, client: LockstepApi):
         self.client = client
 
     """
-Retrieves the API Key with this identifier.
-
-An API Key is an
+    Retrieves the API Key with this identifier. 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).
+
     Parameters
     ----------
     id : str
@@ -46,21 +45,20 @@ def retrieve_api_key(self, id: str, include: str) -> LockstepResponse:
         return self.client.send_request("GET", path, None, {id: str, include: str})
 
     """
-Immediately revokes the API Key with the specified id so it cannot be
+    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.
-
-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
+    revocation. 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).
+
     Parameters
     ----------
     id : str
@@ -71,16 +69,15 @@ def revoke_api_key(self, id: str) -> LockstepResponse:
         return self.client.send_request("DELETE", path, None, {id: str})
 
     """
-Creates an API key with the specified name.
-
-An API Key is an
+    Creates an API key with the specified name. 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).
+
     Parameters
     ----------
     body : ApiKeyModel
@@ -91,7 +88,7 @@ def create_api_key(self, body: ApiKeyModel) -> LockstepResponse:
         return self.client.send_request("POST", path, body, {body: ApiKeyModel})
 
     """
-Queries API Keys for this user using the specified filtering, sorting,
+    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
@@ -100,6 +97,7 @@ def create_api_key(self, body: ApiKeyModel) -> LockstepResponse:
     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).
+
     Parameters
     ----------
     filter : str

src/clients/appenrollments_client.py

@@ -22,53 +22,43 @@ def __init__(self, client: LockstepApi):
         self.client = client
 
     """
-Retrieves the App Enrollment with this identifier.
-
-An App Enrollment
+    Retrieves the App Enrollment with this identifier. An App Enrollment
     represents an app that has been enrolled to the current account. When
     you sign up for an app using the Lockstep Platform, you obtain an
     enrollment record for that app. Example types of apps include connectors
     and feature enhancement apps. The App Enrollment object contains
-    information about this app, its configuration, and settings.
-
-See
+    information about this app, its configuration, and settings. See
     [Applications and
     Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments)
     for more information.
+
     Parameters
     ----------
     id : str
         The unique ID number of the App Enrollment to retrieve
     include : str
         To fetch additional data on this object, specify the list of elements to
-        retrieve.
-Available collections: App, CustomFields
+        retrieve. Available collections: App, CustomFields
     """
     def retrieve_app_enrollment(self, id: str, include: str) -> LockstepResponse:
         path = f"/api/v1/AppEnrollments/{id}"
         return self.client.send_request("GET", path, None, {id: str, include: str})
 
     """
-Updates an existing App Enrollment with the information supplied to this
-    PATCH call.
-
-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. For example, you can provide the
+    Updates an existing App Enrollment with the information supplied to this
+    PATCH call. 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. For example, you can provide the
     field name "IsActive" and specify the new value "False"; this API will
-    then change the value of IsActive to false.
-
-An App Enrollment
-    represents an app that has been enrolled to the current account. When
-    you sign up for an app using the Lockstep Platform, you obtain an
-    enrollment record for that app. Example types of apps include connectors
-    and feature enhancement apps. The App Enrollment object contains
-    information about this app, its configuration, and settings.
-
-See
-    [Applications and
+    then change the value of IsActive to false. An App Enrollment represents
+    an app that has been enrolled to the current account. When you sign up
+    for an app using the Lockstep Platform, you obtain an enrollment record
+    for that app. Example types of apps include connectors and feature
+    enhancement apps. The App Enrollment object contains information about
+    this app, its configuration, and settings. See [Applications and
     Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments)
     for more information.
+
     Parameters
     ----------
     id : str
@@ -81,17 +71,16 @@ def update_app_enrollment(self, id: str, body: object) -> LockstepResponse:
         return self.client.send_request("PATCH", path, body, {id: str, body: object})
 
     """
-Deletes the App Enrollment referred to by this unique identifier. An App
+    Deletes the App Enrollment referred to by this unique identifier. An App
     Enrollment represents an app that has been enrolled to the current
     account. When you sign up for an app using the Lockstep Platform, you
     obtain an enrollment record for that app. Example types of apps include
     connectors and feature enhancement apps. The App Enrollment object
-    contains information about this app, its configuration, and
-    settings.
-
-See [Applications and
+    contains information about this app, its configuration, and settings.
+    See [Applications and
     Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments)
     for more information.
+
     Parameters
     ----------
     id : str
@@ -105,19 +94,16 @@ def delete_app_enrollment(self, id: str, removeEnrollmentData: bool) -> Lockstep
         return self.client.send_request("DELETE", path, None, {id: str, removeEnrollmentData: bool})
 
     """
-Creates one or more App Enrollments within this account and returns the
-    records as created.
-
-An App Enrollment represents an app that has been
+    Creates one or more App Enrollments within this account and returns the
+    records as created. An App Enrollment represents an app that has been
     enrolled to the current account. When you sign up for an app using the
     Lockstep Platform, you obtain an enrollment record for that app. Example
     types of apps include connectors and feature enhancement apps. The App
     Enrollment object contains information about this app, its
-    configuration, and settings.
-
-See [Applications and
+    configuration, and settings. See [Applications and
     Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments)
     for more information.
+
     Parameters
     ----------
     body : list[AppEnrollmentModel]
@@ -128,24 +114,19 @@ def create_app_enrollments(self, body: list[AppEnrollmentModel]) -> LockstepResp
         return self.client.send_request("POST", path, body, {body: list[AppEnrollmentModel]})
 
     """
-Queries App Enrollments for this account using the specified filtering,
-    sorting, nested fetch, and pagination rules requested.
-
-More
-    information on querying can be found on the [Searchlight Query
+    Queries App Enrollments for this account using the specified filtering,
+    sorting, nested fetch, and pagination rules requested. 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.
-
-An App Enrollment represents
-    an app that has been enrolled to the current account. When you sign up
-    for an app using the Lockstep Platform, you obtain an enrollment record
-    for that app. Example types of apps include connectors and feature
+    page on the Lockstep Developer website. An App Enrollment represents an
+    app that has been enrolled to the current account. When you sign up for
+    an app using the Lockstep Platform, you obtain an enrollment record for
+    that app. Example types of apps include connectors and feature
     enhancement apps. The App Enrollment object contains information about
-    this app, its configuration, and settings.
-
-See [Applications and
+    this app, its configuration, and settings. See [Applications and
     Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments)
     for more information.
+
     Parameters
     ----------
     filter : str
@@ -169,25 +150,20 @@ def query_app_enrollments(self, filter: str, include: str, order: str, pageSize:
         return self.client.send_request("GET", path, None, {filter: str, include: str, order: str, pageSize: int, pageNumber: int})
 
     """
-Queries custom fields settings for app enrollment within the Lockstep
+    Queries custom fields settings for app enrollment within the Lockstep
     platform using the specified filtering, sorting, nested fetch, and
-    pagination rules requested.
-
-More information on querying can be found
-    on the [Searchlight Query
+    pagination rules requested. 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.
-
-An App Enrollment represents
-    an app that has been enrolled to the current account. When you sign up
-    for an app using the Lockstep Platform, you obtain an enrollment record
-    for that app. Example types of apps include connectors and feature
+    page on the Lockstep Developer website. An App Enrollment represents an
+    app that has been enrolled to the current account. When you sign up for
+    an app using the Lockstep Platform, you obtain an enrollment record for
+    that app. Example types of apps include connectors and feature
     enhancement apps. The App Enrollment object contains information about
-    this app, its configuration, and settings.
-
-See [Applications and
+    this app, its configuration, and settings. See [Applications and
     Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments)
     for more information.
+
     Parameters
     ----------
     id : str