Skip to content

Commit 699991a

Browse files
author
Ted Spence
committed
Added snake case names
1 parent b710a9c commit 699991a

File tree

67 files changed

+2349
-28
lines changed

Some content is hidden

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

67 files changed

+2349
-28
lines changed

src/lockstep_api.py

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -12,34 +12,34 @@
1212
# @link https://github.com/Lockstep-Network/lockstep-sdk-python
1313
#
1414

15-
from src.clients.ActivitiesClient import ActivitiesClient
16-
from src.clients.ApiKeysClient import ApiKeysClient
17-
from src.clients.AppEnrollmentsClient import AppEnrollmentsClient
18-
from src.clients.ApplicationsClient import ApplicationsClient
19-
from src.clients.AttachmentsClient import AttachmentsClient
20-
from src.clients.CodeDefinitionsClient import CodeDefinitionsClient
21-
from src.clients.CompaniesClient import CompaniesClient
22-
from src.clients.ContactsClient import ContactsClient
23-
from src.clients.CreditMemoAppliedClient import CreditMemoAppliedClient
24-
from src.clients.CurrenciesClient import CurrenciesClient
25-
from src.clients.CustomFieldDefinitionsClient import CustomFieldDefinitionsClient
26-
from src.clients.CustomFieldValuesClient import CustomFieldValuesClient
27-
from src.clients.DefinitionsClient import DefinitionsClient
28-
from src.clients.EmailsClient import EmailsClient
29-
from src.clients.InvoiceHistoryClient import InvoiceHistoryClient
30-
from src.clients.InvoicesClient import InvoicesClient
31-
from src.clients.LeadsClient import LeadsClient
32-
from src.clients.MigrationClient import MigrationClient
33-
from src.clients.NotesClient import NotesClient
34-
from src.clients.PaymentApplicationsClient import PaymentApplicationsClient
35-
from src.clients.PaymentsClient import PaymentsClient
36-
from src.clients.ProvisioningClient import ProvisioningClient
37-
from src.clients.ReportsClient import ReportsClient
38-
from src.clients.StatusClient import StatusClient
39-
from src.clients.SyncClient import SyncClient
40-
from src.clients.UserAccountsClient import UserAccountsClient
41-
from src.clients.UserRolesClient import UserRolesClient
42-
from src.models.LockstepResponse import LockstepResponse
15+
from src.clients.activities_client import ActivitiesClient
16+
from src.clients.apikeys_client import ApiKeysClient
17+
from src.clients.appenrollments_client import AppEnrollmentsClient
18+
from src.clients.applications_client import ApplicationsClient
19+
from src.clients.attachments_client import AttachmentsClient
20+
from src.clients.codedefinitions_client import CodeDefinitionsClient
21+
from src.clients.companies_client import CompaniesClient
22+
from src.clients.contacts_client import ContactsClient
23+
from src.clients.creditmemoapplied_client import CreditMemoAppliedClient
24+
from src.clients.currencies_client import CurrenciesClient
25+
from src.clients.customfielddefinitions_client import CustomFieldDefinitionsClient
26+
from src.clients.customfieldvalues_client import CustomFieldValuesClient
27+
from src.clients.definitions_client import DefinitionsClient
28+
from src.clients.emails_client import EmailsClient
29+
from src.clients.invoicehistory_client import InvoiceHistoryClient
30+
from src.clients.invoices_client import InvoicesClient
31+
from src.clients.leads_client import LeadsClient
32+
from src.clients.migration_client import MigrationClient
33+
from src.clients.notes_client import NotesClient
34+
from src.clients.paymentapplications_client import PaymentApplicationsClient
35+
from src.clients.payments_client import PaymentsClient
36+
from src.clients.provisioning_client import ProvisioningClient
37+
from src.clients.reports_client import ReportsClient
38+
from src.clients.status_client import StatusClient
39+
from src.clients.sync_client import SyncClient
40+
from src.clients.useraccounts_client import UserAccountsClient
41+
from src.clients.userroles_client import UserRolesClient
42+
from src.models.lockstep_response import LockstepResponse
4343
import requests
4444
import urllib.parse
4545

src/models/activitymodel.py

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
#
2+
# Lockstep Software Development Kit for Python
3+
#
4+
# (c) 2021-2022 Lockstep, Inc.
5+
#
6+
# For the full copyright and license information, please view the LICENSE
7+
# file that was distributed with this source code.
8+
#
9+
# @author Ted Spence <[email protected]>
10+
# @copyright 2021-2022 Lockstep, Inc.
11+
# @version 2021.39
12+
# @link https://github.com/Lockstep-Network/lockstep-sdk-python
13+
#
14+
15+
16+
17+
from src.models.attachmentmodel import AttachmentModel
18+
from src.models.notemodel import NoteModel
19+
from src.models.customfielddefinitionmodel import CustomFieldDefinitionModel
20+
from src.models.customfieldvaluemodel import CustomFieldValueModel
21+
22+
"""
23+
An Activity contains information about work being done on a specific accounting task.
24+
You can use Activities to track information about who has been assigned a specific task,
25+
the current status of the task, the name and description given for the particular task,
26+
the priority of the task, and any amounts collected, paid, or credited for the task.
27+
"""
28+
class ActivityModel:
29+
activityId: str
30+
groupKey: str
31+
companyId: str
32+
activityTypeCode: str
33+
activityName: str
34+
activityDescription: str
35+
activityStatus: str
36+
isOpen: bool
37+
priority: str
38+
userAssignedTo: str
39+
dateAssigned: str
40+
dateClosed: str
41+
snoozeUntilDate: str
42+
created: str
43+
createdUserId: str
44+
modified: str
45+
modifiedUserId: str
46+
amountCollected: float
47+
amountPaid: float
48+
creditGiven: float
49+
isUnread: bool
50+
isArchived: bool
51+
attachments: list[AttachmentModel]
52+
notes: list[NoteModel]
53+
customFieldDefinitions: list[CustomFieldDefinitionModel]
54+
customFieldValues: list[CustomFieldValueModel]
55+

src/models/agingmodel.py

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
#
2+
# Lockstep Software Development Kit for Python
3+
#
4+
# (c) 2021-2022 Lockstep, Inc.
5+
#
6+
# For the full copyright and license information, please view the LICENSE
7+
# file that was distributed with this source code.
8+
#
9+
# @author Ted Spence <[email protected]>
10+
# @copyright 2021-2022 Lockstep, Inc.
11+
# @version 2021.39
12+
# @link https://github.com/Lockstep-Network/lockstep-sdk-python
13+
#
14+
15+
16+
17+
18+
"""
19+
Represents an aging record
20+
"""
21+
class AgingModel:
22+
bucket: int
23+
currencyCode: str
24+
outstandingBalance: float
25+

src/models/apikeymodel.py

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
#
2+
# Lockstep Software Development Kit for Python
3+
#
4+
# (c) 2021-2022 Lockstep, Inc.
5+
#
6+
# For the full copyright and license information, please view the LICENSE
7+
# file that was distributed with this source code.
8+
#
9+
# @author Ted Spence <[email protected]>
10+
# @copyright 2021-2022 Lockstep, Inc.
11+
# @version 2021.39
12+
# @link https://github.com/Lockstep-Network/lockstep-sdk-python
13+
#
14+
15+
16+
17+
18+
"""
19+
An API Key is an authentication token that you may use with the Lockstep API. Because API Keys
20+
do not have an expiration date, they are well suited for unattended processes. Each API Key
21+
is associated with a user, and may be revoked to prevent it from accessing the Lockstep API.
22+
When you create an API Key, make sure to save the value in a secure location. Lockstep cannot
23+
retrieve an API Key once it is created.
24+
25+
For more information, see [API Keys](https://developer.lockstep.io/docs/api-keys).
26+
"""
27+
class ApiKeyModel:
28+
apiKeyId: str
29+
groupKey: str
30+
name: str
31+
apiKey: str
32+
keyPrefix: str
33+
created: str
34+
createdUserId: str
35+
revoked: str
36+
revokedUserId: str
37+
expires: str
38+
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
#
2+
# Lockstep Software Development Kit for Python
3+
#
4+
# (c) 2021-2022 Lockstep, Inc.
5+
#
6+
# For the full copyright and license information, please view the LICENSE
7+
# file that was distributed with this source code.
8+
#
9+
# @author Ted Spence <[email protected]>
10+
# @copyright 2021-2022 Lockstep, Inc.
11+
# @version 2021.39
12+
# @link https://github.com/Lockstep-Network/lockstep-sdk-python
13+
#
14+
15+
16+
17+
18+
"""
19+
App enrollment and custom field merged into one
20+
"""
21+
class AppEnrollmentCustomFieldModel:
22+
appEnrollmentId: str
23+
appId: str
24+
name: str
25+
appType: str
26+
groupKey: str
27+
customFieldDefinitionId: str
28+
customFieldLabel: str
29+
dataType: str
30+
sortOrder: int
31+
stringValue: str
32+
numericValue: float
33+

src/models/appenrollmentmodel.py

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
#
2+
# Lockstep Software Development Kit for Python
3+
#
4+
# (c) 2021-2022 Lockstep, Inc.
5+
#
6+
# For the full copyright and license information, please view the LICENSE
7+
# file that was distributed with this source code.
8+
#
9+
# @author Ted Spence <[email protected]>
10+
# @copyright 2021-2022 Lockstep, Inc.
11+
# @version 2021.39
12+
# @link https://github.com/Lockstep-Network/lockstep-sdk-python
13+
#
14+
15+
16+
17+
from src.models.applicationmodel import ApplicationModel
18+
from src.models.customfielddefinitionmodel import CustomFieldDefinitionModel
19+
from src.models.customfieldvaluemodel import CustomFieldValueModel
20+
from src.models.syncrequestmodel import SyncRequestModel
21+
from src.models.erpinfodatamodel import ErpInfoDataModel
22+
from src.models.connectorinfomodel import ConnectorInfoModel
23+
24+
"""
25+
An AppEnrollment represents an app that has been enrolled to the current account. When you sign up for an
26+
app using the Lockstep Platform, you obtain an enrollment record for that app. Example types of apps include
27+
connectors and feature enhancement apps. The App Enrollment object contains information about this app, its
28+
configuration, and settings.
29+
30+
See [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) for more information.
31+
"""
32+
class AppEnrollmentModel:
33+
appEnrollmentId: str
34+
appId: str
35+
groupKey: str
36+
isActive: bool
37+
created: str
38+
createdUserId: str
39+
modified: str
40+
modifiedUserId: str
41+
cronSettings: str
42+
syncScheduleIsActive: bool
43+
app: ApplicationModel
44+
customFieldDefinitions: list[CustomFieldDefinitionModel]
45+
customFieldValues: list[CustomFieldValueModel]
46+
lastSync: SyncRequestModel
47+
erpInfo: ErpInfoDataModel
48+
connectorInfo: ConnectorInfoModel
49+

src/models/applicationmodel.py

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
#
2+
# Lockstep Software Development Kit for Python
3+
#
4+
# (c) 2021-2022 Lockstep, Inc.
5+
#
6+
# For the full copyright and license information, please view the LICENSE
7+
# file that was distributed with this source code.
8+
#
9+
# @author Ted Spence <[email protected]>
10+
# @copyright 2021-2022 Lockstep, Inc.
11+
# @version 2021.39
12+
# @link https://github.com/Lockstep-Network/lockstep-sdk-python
13+
#
14+
15+
16+
17+
from src.models.notemodel import NoteModel
18+
from src.models.attachmentmodel import AttachmentModel
19+
from src.models.customfielddefinitionmodel import CustomFieldDefinitionModel
20+
from src.models.customfieldvaluemodel import CustomFieldValueModel
21+
22+
"""
23+
An Application represents a feature available to customers within the Lockstep Platform. You can create
24+
Applications by working with your Lockstep business development manager and publish them on the platform
25+
so that customers can browse and find your Application on the Lockstep Platform Marketplace. When a
26+
customer adds an Application to their account, they obtain an AppEnrollment which represents that customer's
27+
instance of this Application. The customer-specific AppEnrollment contains a customer's configuration data
28+
for the Application, which is not customer-specific.
29+
30+
See [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) for more information.
31+
--swaggerCategory:Platform
32+
"""
33+
class ApplicationModel:
34+
appId: str
35+
name: str
36+
description: str
37+
appType: str
38+
ownerId: str
39+
projectUrl: str
40+
iconUrl: str
41+
priceTerms: str
42+
createdUserId: str
43+
modifiedUserId: str
44+
created: str
45+
modified: str
46+
isActive: bool
47+
wikiURL: str
48+
groupKey: str
49+
notes: list[NoteModel]
50+
attachments: list[AttachmentModel]
51+
customFieldDefinitions: list[CustomFieldDefinitionModel]
52+
customFieldValues: list[CustomFieldValueModel]
53+
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
#
2+
# Lockstep Software Development Kit for Python
3+
#
4+
# (c) 2021-2022 Lockstep, Inc.
5+
#
6+
# For the full copyright and license information, please view the LICENSE
7+
# file that was distributed with this source code.
8+
#
9+
# @author Ted Spence <[email protected]>
10+
# @copyright 2021-2022 Lockstep, Inc.
11+
# @version 2021.39
12+
# @link https://github.com/Lockstep-Network/lockstep-sdk-python
13+
#
14+
15+
16+
17+
18+
"""
19+
Aggregated Accounts Receivable Aging information.
20+
"""
21+
class ArAgingHeaderInfoModel:
22+
groupKey: str
23+
reportBucket: str
24+
totalCustomers: int
25+
totalInvoicesOutstanding: int
26+
totalOutstandingAmount: float
27+
totalArAmount: float
28+
percentageOfTotalAr: float
29+

src/models/arheaderinfomodel.py

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
#
2+
# Lockstep Software Development Kit for Python
3+
#
4+
# (c) 2021-2022 Lockstep, Inc.
5+
#
6+
# For the full copyright and license information, please view the LICENSE
7+
# file that was distributed with this source code.
8+
#
9+
# @author Ted Spence <[email protected]>
10+
# @copyright 2021-2022 Lockstep, Inc.
11+
# @version 2021.39
12+
# @link https://github.com/Lockstep-Network/lockstep-sdk-python
13+
#
14+
15+
16+
17+
18+
"""
19+
Aggregated Accounts Receivable information.
20+
"""
21+
class ArHeaderInfoModel:
22+
groupKey: str
23+
reportPeriod: str
24+
totalCustomers: int
25+
totalInvoices: int
26+
totalInvoicedAmount: float
27+
totalUnappliedPayments: float
28+
totalCollected: float
29+
totalArAmount: float
30+
totalInvoicesPaid: int
31+
totalInvoicesPastDue: int
32+
totalInvoices90DaysPastDue: int
33+
totalPastDueAmount: float
34+
totalPastDueAmount90Days: float
35+
percentageOfTotalAr: float
36+
dso: float
37+
totalInvoiceAmountCurrentYear: float
38+
totalInvoiceAmountPreviousYear: float
39+
totalPaymentAmountCurrentYear: float
40+
totalCollectedPastThirtyDays: int
41+
totalInvoicesPaidPastThirtyDays: int
42+
percentageOfTotalAr90DaysPastDue: float
43+

0 commit comments

Comments
 (0)