teamdbapi 3.10.1__py3-none-any.whl → 3.12.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. teamdbapi/api/assembly_api.py +27 -27
  2. teamdbapi/api/car_api.py +9 -9
  3. teamdbapi/api/component_api.py +12 -12
  4. teamdbapi/api/config_api.py +1 -1
  5. teamdbapi/api/criteria_api.py +6 -6
  6. teamdbapi/api/edit_api.py +6 -6
  7. teamdbapi/api/event_api.py +11 -11
  8. teamdbapi/api/fixed_field_api.py +3 -3
  9. teamdbapi/api/group_api.py +6 -6
  10. teamdbapi/api/import_export_api.py +11 -11
  11. teamdbapi/api/issue_api.py +103 -18
  12. teamdbapi/api/lap_api.py +7 -7
  13. teamdbapi/api/lap_report_api.py +5 -5
  14. teamdbapi/api/model_field_api.py +11 -11
  15. teamdbapi/api/mounting_api.py +3 -3
  16. teamdbapi/api/notes_authorization_api.py +5 -5
  17. teamdbapi/api/overall_api.py +1 -1
  18. teamdbapi/api/parameter_api.py +15 -15
  19. teamdbapi/api/parameter_binding_api.py +5 -5
  20. teamdbapi/api/part_api.py +9 -9
  21. teamdbapi/api/report_api.py +3 -3
  22. teamdbapi/api/revision_api.py +20 -20
  23. teamdbapi/api/revision_editor_selector_api.py +9 -9
  24. teamdbapi/api/run_api.py +6 -6
  25. teamdbapi/api/script_api.py +5 -5
  26. teamdbapi/api/session_api.py +7 -7
  27. teamdbapi/api/target_api.py +4 -4
  28. teamdbapi/api/team_db_list_api.py +10 -10
  29. teamdbapi/api/team_db_view_api.py +5 -5
  30. teamdbapi/api/tire_api.py +6 -6
  31. teamdbapi/api/tire_set_api.py +5 -5
  32. teamdbapi/api/track_api.py +5 -5
  33. teamdbapi/api/track_layout_api.py +5 -5
  34. teamdbapi/api/update_request_api.py +2 -2
  35. teamdbapi/api/user_api.py +5 -5
  36. teamdbapi/api/value_field_api.py +6 -6
  37. teamdbapi/api/version_api.py +4 -4
  38. teamdbapi/configuration.py +7 -0
  39. teamdbapi/models/calibration.py +4 -4
  40. teamdbapi/models/group.py +2 -2
  41. teamdbapi/models/lap.py +2 -2
  42. teamdbapi/models/lap_report_options.py +2 -2
  43. teamdbapi/models/parameter.py +2 -2
  44. teamdbapi/models/part.py +35 -7
  45. teamdbapi/models/part_count.py +33 -5
  46. teamdbapi/models/session.py +2 -2
  47. teamdbapi/models/target.py +2 -2
  48. teamdbapi/models/team_db_list_item.py +31 -3
  49. teamdbapi-3.12.0.dist-info/METADATA +135 -0
  50. {teamdbapi-3.10.1.dist-info → teamdbapi-3.12.0.dist-info}/RECORD +52 -52
  51. {teamdbapi-3.10.1.dist-info → teamdbapi-3.12.0.dist-info}/licenses/LICENSE +1 -1
  52. teamdbapi-3.10.1.dist-info/METADATA +0 -91
  53. {teamdbapi-3.10.1.dist-info → teamdbapi-3.12.0.dist-info}/WHEEL +0 -0
teamdbapi/models/group.py CHANGED
@@ -156,7 +156,7 @@ class Group(object):
156
156
  def ParentGroupId(self):
157
157
  """Gets the ParentGroupId of this Group. # noqa: E501
158
158
 
159
- The parent group id to which the group belongs to. Leave the property to Guid.Empty (00000000-0000-0000-0000-000000000000) if the group doesn't have parent. # noqa: E501
159
+ The parent group id to which the group belongs to. Leave the property to Guid.Empty (00000000-0000-0000-0000-000000000000) if the group does not have parent. # noqa: E501
160
160
 
161
161
  :return: The ParentGroupId of this Group. # noqa: E501
162
162
  :rtype: str
@@ -167,7 +167,7 @@ class Group(object):
167
167
  def ParentGroupId(self, ParentGroupId):
168
168
  """Sets the ParentGroupId of this Group.
169
169
 
170
- The parent group id to which the group belongs to. Leave the property to Guid.Empty (00000000-0000-0000-0000-000000000000) if the group doesn't have parent. # noqa: E501
170
+ The parent group id to which the group belongs to. Leave the property to Guid.Empty (00000000-0000-0000-0000-000000000000) if the group does not have parent. # noqa: E501
171
171
 
172
172
  :param ParentGroupId: The ParentGroupId of this Group. # noqa: E501
173
173
  :type: str
teamdbapi/models/lap.py CHANGED
@@ -559,7 +559,7 @@ class Lap(object):
559
559
  def LapTimePower(self):
560
560
  """Gets the LapTimePower of this Lap. # noqa: E501
561
561
 
562
- Time elpased in power # noqa: E501
562
+ Time elapsed in power # noqa: E501
563
563
 
564
564
  :return: The LapTimePower of this Lap. # noqa: E501
565
565
  :rtype: float
@@ -570,7 +570,7 @@ class Lap(object):
570
570
  def LapTimePower(self, LapTimePower):
571
571
  """Sets the LapTimePower of this Lap.
572
572
 
573
- Time elpased in power # noqa: E501
573
+ Time elapsed in power # noqa: E501
574
574
 
575
575
  :param LapTimePower: The LapTimePower of this Lap. # noqa: E501
576
576
  :type: float
@@ -121,7 +121,7 @@ class LapReportOptions(object):
121
121
  def LapReportFilePath(self):
122
122
  """Gets the LapReportFilePath of this LapReportOptions. # noqa: E501
123
123
 
124
- The file path to the lap report. You have to provide the file extension for example : C:/path/MyFile.csv. The path must be described only by / or \\\\\\\\. # noqa: E501
124
+ The file path to the lap report. You must provide the file extension for example : C:/path/MyFile.csv. The path must be described only by / or \\\\\\\\. # noqa: E501
125
125
 
126
126
  :return: The LapReportFilePath of this LapReportOptions. # noqa: E501
127
127
  :rtype: str
@@ -132,7 +132,7 @@ class LapReportOptions(object):
132
132
  def LapReportFilePath(self, LapReportFilePath):
133
133
  """Sets the LapReportFilePath of this LapReportOptions.
134
134
 
135
- The file path to the lap report. You have to provide the file extension for example : C:/path/MyFile.csv. The path must be described only by / or \\\\\\\\. # noqa: E501
135
+ The file path to the lap report. You must provide the file extension for example : C:/path/MyFile.csv. The path must be described only by / or \\\\\\\\. # noqa: E501
136
136
 
137
137
  :param LapReportFilePath: The LapReportFilePath of this LapReportOptions. # noqa: E501
138
138
  :type: str
@@ -186,7 +186,7 @@ class Parameter(object):
186
186
  def TargetId(self):
187
187
  """Gets the TargetId of this Parameter. # noqa: E501
188
188
 
189
- The target id to which the parameter belongs to. Parameters are linked to the version through the VersionParam object. But you don't have to care about this. Just call th parameters Api function and provide a version id to which you want to get the parameters. # noqa: E501
189
+ The target id to which the parameter belongs to. Parameters are linked to the version through the VersionParam object. But you do not have to care about this. Just call th parameters Api function and provide a version id to which you want to get the parameters. # noqa: E501
190
190
 
191
191
  :return: The TargetId of this Parameter. # noqa: E501
192
192
  :rtype: str
@@ -197,7 +197,7 @@ class Parameter(object):
197
197
  def TargetId(self, TargetId):
198
198
  """Sets the TargetId of this Parameter.
199
199
 
200
- The target id to which the parameter belongs to. Parameters are linked to the version through the VersionParam object. But you don't have to care about this. Just call th parameters Api function and provide a version id to which you want to get the parameters. # noqa: E501
200
+ The target id to which the parameter belongs to. Parameters are linked to the version through the VersionParam object. But you do not have to care about this. Just call th parameters Api function and provide a version id to which you want to get the parameters. # noqa: E501
201
201
 
202
202
  :param TargetId: The TargetId of this Parameter. # noqa: E501
203
203
  :type: str
teamdbapi/models/part.py CHANGED
@@ -68,7 +68,8 @@ class Part(object):
68
68
  'DnuDistance': 'float',
69
69
  'DnuTime': 'float',
70
70
  'DnuEnergy': 'float',
71
- 'DnuDistanceFactored': 'float'
71
+ 'DnuDistanceFactored': 'float',
72
+ 'SupportedClassTags': 'str'
72
73
  }
73
74
 
74
75
  attribute_map = {
@@ -107,10 +108,11 @@ class Part(object):
107
108
  'DnuDistance': 'DnuDistance',
108
109
  'DnuTime': 'DnuTime',
109
110
  'DnuEnergy': 'DnuEnergy',
110
- 'DnuDistanceFactored': 'DnuDistanceFactored'
111
+ 'DnuDistanceFactored': 'DnuDistanceFactored',
112
+ 'SupportedClassTags': 'SupportedClassTags'
111
113
  }
112
114
 
113
- def __init__(self, PartId=None, IsLifed=None, PartName=None, ManufacturerNumber=None, Description=None, Tags=None, IsClass=None, HasExpirationDate=None, MaxDistance=None, MinDistance=None, MaxTime=None, DateCreationUtc=None, Creator=None, LastUpdateDateUtc=None, LastUpdateUser=None, PartStatus=None, PartType=None, Manufacturer=None, ParentPartClass=None, IconId=None, Department=None, Annotation=None, MultiManufacturer=None, ClassificationCode=None, MaxDistanceFactored=None, FactorId=None, MaxEnergy=None, CriteriaSetId=None, InheritedStatus=None, MinWeight=None, MaxWeight=None, IsSensor=None, DnuDistance=None, DnuTime=None, DnuEnergy=None, DnuDistanceFactored=None, _configuration=None): # noqa: E501
115
+ def __init__(self, PartId=None, IsLifed=None, PartName=None, ManufacturerNumber=None, Description=None, Tags=None, IsClass=None, HasExpirationDate=None, MaxDistance=None, MinDistance=None, MaxTime=None, DateCreationUtc=None, Creator=None, LastUpdateDateUtc=None, LastUpdateUser=None, PartStatus=None, PartType=None, Manufacturer=None, ParentPartClass=None, IconId=None, Department=None, Annotation=None, MultiManufacturer=None, ClassificationCode=None, MaxDistanceFactored=None, FactorId=None, MaxEnergy=None, CriteriaSetId=None, InheritedStatus=None, MinWeight=None, MaxWeight=None, IsSensor=None, DnuDistance=None, DnuTime=None, DnuEnergy=None, DnuDistanceFactored=None, SupportedClassTags=None, _configuration=None): # noqa: E501
114
116
  """Part - a model defined in Swagger""" # noqa: E501
115
117
  if _configuration is None:
116
118
  _configuration = Configuration()
@@ -152,6 +154,7 @@ class Part(object):
152
154
  self._DnuTime = None
153
155
  self._DnuEnergy = None
154
156
  self._DnuDistanceFactored = None
157
+ self._SupportedClassTags = None
155
158
  self.discriminator = None
156
159
 
157
160
  self.PartId = PartId
@@ -222,6 +225,8 @@ class Part(object):
222
225
  self.DnuEnergy = DnuEnergy
223
226
  if DnuDistanceFactored is not None:
224
227
  self.DnuDistanceFactored = DnuDistanceFactored
228
+ if SupportedClassTags is not None:
229
+ self.SupportedClassTags = SupportedClassTags
225
230
 
226
231
  @property
227
232
  def PartId(self):
@@ -915,7 +920,7 @@ class Part(object):
915
920
  def MinWeight(self):
916
921
  """Gets the MinWeight of this Part. # noqa: E501
917
922
 
918
- Minimum authorized weight for the part # noqa: E501
923
+ Minimum authorised weight for the part # noqa: E501
919
924
 
920
925
  :return: The MinWeight of this Part. # noqa: E501
921
926
  :rtype: float
@@ -926,7 +931,7 @@ class Part(object):
926
931
  def MinWeight(self, MinWeight):
927
932
  """Sets the MinWeight of this Part.
928
933
 
929
- Minimum authorized weight for the part # noqa: E501
934
+ Minimum authorised weight for the part # noqa: E501
930
935
 
931
936
  :param MinWeight: The MinWeight of this Part. # noqa: E501
932
937
  :type: float
@@ -938,7 +943,7 @@ class Part(object):
938
943
  def MaxWeight(self):
939
944
  """Gets the MaxWeight of this Part. # noqa: E501
940
945
 
941
- Maximum authorized weight for the part # noqa: E501
946
+ Maximum authorised weight for the part # noqa: E501
942
947
 
943
948
  :return: The MaxWeight of this Part. # noqa: E501
944
949
  :rtype: float
@@ -949,7 +954,7 @@ class Part(object):
949
954
  def MaxWeight(self, MaxWeight):
950
955
  """Sets the MaxWeight of this Part.
951
956
 
952
- Maximum authorized weight for the part # noqa: E501
957
+ Maximum authorised weight for the part # noqa: E501
953
958
 
954
959
  :param MaxWeight: The MaxWeight of this Part. # noqa: E501
955
960
  :type: float
@@ -1072,6 +1077,29 @@ class Part(object):
1072
1077
 
1073
1078
  self._DnuDistanceFactored = DnuDistanceFactored
1074
1079
 
1080
+ @property
1081
+ def SupportedClassTags(self):
1082
+ """Gets the SupportedClassTags of this Part. # noqa: E501
1083
+
1084
+ Contient la liste de tous les tags supportés par la part si elle est de type Class Contient la liste du sous ensemble des tags supportés par la part si elle dérive d'une part class (sous ensemble des tags appartient aux tags de la part class). # noqa: E501
1085
+
1086
+ :return: The SupportedClassTags of this Part. # noqa: E501
1087
+ :rtype: str
1088
+ """
1089
+ return self._SupportedClassTags
1090
+
1091
+ @SupportedClassTags.setter
1092
+ def SupportedClassTags(self, SupportedClassTags):
1093
+ """Sets the SupportedClassTags of this Part.
1094
+
1095
+ Contient la liste de tous les tags supportés par la part si elle est de type Class Contient la liste du sous ensemble des tags supportés par la part si elle dérive d'une part class (sous ensemble des tags appartient aux tags de la part class). # noqa: E501
1096
+
1097
+ :param SupportedClassTags: The SupportedClassTags of this Part. # noqa: E501
1098
+ :type: str
1099
+ """
1100
+
1101
+ self._SupportedClassTags = SupportedClassTags
1102
+
1075
1103
  def to_dict(self):
1076
1104
  """Returns the model properties as a dict"""
1077
1105
  result = {}
@@ -37,7 +37,8 @@ class PartCount(object):
37
37
  'PartChildId': 'str',
38
38
  'Count': 'int',
39
39
  'LastUpdateDateUtc': 'datetime',
40
- 'LastUpdateUser': 'str'
40
+ 'LastUpdateUser': 'str',
41
+ 'ClassTags': 'str'
41
42
  }
42
43
 
43
44
  attribute_map = {
@@ -45,10 +46,11 @@ class PartCount(object):
45
46
  'PartChildId': 'PartChildId',
46
47
  'Count': 'Count',
47
48
  'LastUpdateDateUtc': 'LastUpdateDateUtc',
48
- 'LastUpdateUser': 'LastUpdateUser'
49
+ 'LastUpdateUser': 'LastUpdateUser',
50
+ 'ClassTags': 'ClassTags'
49
51
  }
50
52
 
51
- def __init__(self, PartParentId=None, PartChildId=None, Count=None, LastUpdateDateUtc=None, LastUpdateUser=None, _configuration=None): # noqa: E501
53
+ def __init__(self, PartParentId=None, PartChildId=None, Count=None, LastUpdateDateUtc=None, LastUpdateUser=None, ClassTags=None, _configuration=None): # noqa: E501
52
54
  """PartCount - a model defined in Swagger""" # noqa: E501
53
55
  if _configuration is None:
54
56
  _configuration = Configuration()
@@ -59,6 +61,7 @@ class PartCount(object):
59
61
  self._Count = None
60
62
  self._LastUpdateDateUtc = None
61
63
  self._LastUpdateUser = None
64
+ self._ClassTags = None
62
65
  self.discriminator = None
63
66
 
64
67
  self.PartParentId = PartParentId
@@ -68,6 +71,8 @@ class PartCount(object):
68
71
  self.LastUpdateDateUtc = LastUpdateDateUtc
69
72
  if LastUpdateUser is not None:
70
73
  self.LastUpdateUser = LastUpdateUser
74
+ if ClassTags is not None:
75
+ self.ClassTags = ClassTags
71
76
 
72
77
  @property
73
78
  def PartParentId(self):
@@ -123,7 +128,7 @@ class PartCount(object):
123
128
  def Count(self):
124
129
  """Gets the Count of this PartCount. # noqa: E501
125
130
 
126
- TODO Nombre d'occurence du part enfant dans le parent # noqa: E501
131
+ Nombre d'occurence du part enfant dans le parent # noqa: E501
127
132
 
128
133
  :return: The Count of this PartCount. # noqa: E501
129
134
  :rtype: int
@@ -134,7 +139,7 @@ class PartCount(object):
134
139
  def Count(self, Count):
135
140
  """Sets the Count of this PartCount.
136
141
 
137
- TODO Nombre d'occurence du part enfant dans le parent # noqa: E501
142
+ Nombre d'occurence du part enfant dans le parent # noqa: E501
138
143
 
139
144
  :param Count: The Count of this PartCount. # noqa: E501
140
145
  :type: int
@@ -190,6 +195,29 @@ class PartCount(object):
190
195
 
191
196
  self._LastUpdateUser = LastUpdateUser
192
197
 
198
+ @property
199
+ def ClassTags(self):
200
+ """Gets the ClassTags of this PartCount. # noqa: E501
201
+
202
+ Les tags contenant les valeurs des classes dérivées possibles pour le part count # noqa: E501
203
+
204
+ :return: The ClassTags of this PartCount. # noqa: E501
205
+ :rtype: str
206
+ """
207
+ return self._ClassTags
208
+
209
+ @ClassTags.setter
210
+ def ClassTags(self, ClassTags):
211
+ """Sets the ClassTags of this PartCount.
212
+
213
+ Les tags contenant les valeurs des classes dérivées possibles pour le part count # noqa: E501
214
+
215
+ :param ClassTags: The ClassTags of this PartCount. # noqa: E501
216
+ :type: str
217
+ """
218
+
219
+ self._ClassTags = ClassTags
220
+
193
221
  def to_dict(self):
194
222
  """Returns the model properties as a dict"""
195
223
  result = {}
@@ -469,7 +469,7 @@ class Session(object):
469
469
  def DefaultAssemblies(self):
470
470
  """Gets the DefaultAssemblies of this Session. # noqa: E501
471
471
 
472
- List of the default Assemblies used to create the first session's run. You have to specify one assemblies by target. # noqa: E501
472
+ List of the default Assemblies used to create the first session's run. You must specify one assemblies by target. # noqa: E501
473
473
 
474
474
  :return: The DefaultAssemblies of this Session. # noqa: E501
475
475
  :rtype: list[str]
@@ -480,7 +480,7 @@ class Session(object):
480
480
  def DefaultAssemblies(self, DefaultAssemblies):
481
481
  """Sets the DefaultAssemblies of this Session.
482
482
 
483
- List of the default Assemblies used to create the first session's run. You have to specify one assemblies by target. # noqa: E501
483
+ List of the default Assemblies used to create the first session's run. You must specify one assemblies by target. # noqa: E501
484
484
 
485
485
  :param DefaultAssemblies: The DefaultAssemblies of this Session. # noqa: E501
486
486
  :type: list[str]
@@ -405,7 +405,7 @@ class Target(object):
405
405
  def AutoGenerateAssemblyEventType(self):
406
406
  """Gets the AutoGenerateAssemblyEventType of this Target. # noqa: E501
407
407
 
408
- List of event types separated with ; for which auto generate assembly is allowed. If empty, all the event types are allowed. Example: Race;Test # noqa: E501
408
+ List of event types separated with ; for which auto-generate assembly is allowed. If empty, all the event types are allowed. Example: Race;Test # noqa: E501
409
409
 
410
410
  :return: The AutoGenerateAssemblyEventType of this Target. # noqa: E501
411
411
  :rtype: str
@@ -416,7 +416,7 @@ class Target(object):
416
416
  def AutoGenerateAssemblyEventType(self, AutoGenerateAssemblyEventType):
417
417
  """Sets the AutoGenerateAssemblyEventType of this Target.
418
418
 
419
- List of event types separated with ; for which auto generate assembly is allowed. If empty, all the event types are allowed. Example: Race;Test # noqa: E501
419
+ List of event types separated with ; for which auto-generate assembly is allowed. If empty, all the event types are allowed. Example: Race;Test # noqa: E501
420
420
 
421
421
  :param AutoGenerateAssemblyEventType: The AutoGenerateAssemblyEventType of this Target. # noqa: E501
422
422
  :type: str
@@ -36,17 +36,19 @@ class TeamDBListItem(object):
36
36
  'Id': 'str',
37
37
  'ListId': 'str',
38
38
  'Name': 'str',
39
- 'ItemOrder': 'int'
39
+ 'ItemOrder': 'int',
40
+ 'Enabled': 'bool'
40
41
  }
41
42
 
42
43
  attribute_map = {
43
44
  'Id': 'Id',
44
45
  'ListId': 'ListId',
45
46
  'Name': 'Name',
46
- 'ItemOrder': 'ItemOrder'
47
+ 'ItemOrder': 'ItemOrder',
48
+ 'Enabled': 'Enabled'
47
49
  }
48
50
 
49
- def __init__(self, Id=None, ListId=None, Name=None, ItemOrder=None, _configuration=None): # noqa: E501
51
+ def __init__(self, Id=None, ListId=None, Name=None, ItemOrder=None, Enabled=None, _configuration=None): # noqa: E501
50
52
  """TeamDBListItem - a model defined in Swagger""" # noqa: E501
51
53
  if _configuration is None:
52
54
  _configuration = Configuration()
@@ -56,6 +58,7 @@ class TeamDBListItem(object):
56
58
  self._ListId = None
57
59
  self._Name = None
58
60
  self._ItemOrder = None
61
+ self._Enabled = None
59
62
  self.discriminator = None
60
63
 
61
64
  self.Id = Id
@@ -63,6 +66,8 @@ class TeamDBListItem(object):
63
66
  self.Name = Name
64
67
  if ItemOrder is not None:
65
68
  self.ItemOrder = ItemOrder
69
+ if Enabled is not None:
70
+ self.Enabled = Enabled
66
71
 
67
72
  @property
68
73
  def Id(self):
@@ -165,6 +170,29 @@ class TeamDBListItem(object):
165
170
 
166
171
  self._ItemOrder = ItemOrder
167
172
 
173
+ @property
174
+ def Enabled(self):
175
+ """Gets the Enabled of this TeamDBListItem. # noqa: E501
176
+
177
+ Indique si l'item est activé # noqa: E501
178
+
179
+ :return: The Enabled of this TeamDBListItem. # noqa: E501
180
+ :rtype: bool
181
+ """
182
+ return self._Enabled
183
+
184
+ @Enabled.setter
185
+ def Enabled(self, Enabled):
186
+ """Sets the Enabled of this TeamDBListItem.
187
+
188
+ Indique si l'item est activé # noqa: E501
189
+
190
+ :param Enabled: The Enabled of this TeamDBListItem. # noqa: E501
191
+ :type: bool
192
+ """
193
+
194
+ self._Enabled = Enabled
195
+
168
196
  def to_dict(self):
169
197
  """Returns the model properties as a dict"""
170
198
  result = {}
@@ -0,0 +1,135 @@
1
+ Metadata-Version: 2.4
2
+ Name: teamdbapi
3
+ Version: 3.12.0
4
+ Summary: Easily access the TeamDB Web API.
5
+ Keywords: teamdbapi,Trackside,Trackside Software,TeamDB
6
+ Author-email: Trackside Software <support@trackside.fr>
7
+ Requires-Python: >=3.4
8
+ Description-Content-Type: text/markdown
9
+ Classifier: License :: OSI Approved :: MIT License
10
+ Classifier: Programming Language :: Python
11
+ Classifier: Programming Language :: Python :: 3
12
+ License-File: LICENSE
13
+ Requires-Dist: certifi >= 14.05.14
14
+ Requires-Dist: six >= 1.10
15
+ Requires-Dist: python_dateutil >= 2.5.3
16
+ Requires-Dist: setuptools >= 21.0.0
17
+ Requires-Dist: urllib3 >= 1.15.1
18
+ Project-URL: Home, https://www.tracksidesoftware.fr/teamdb
19
+
20
+ # teamdbapi
21
+ This module enables you to easily access the TeamDB Web API.
22
+
23
+ - Package version: 3.12.0
24
+ - TeamDB Web API version: 2.0
25
+
26
+ ## Requirements.
27
+
28
+ - Python 3.4+
29
+ - TeamDB 3.12.0
30
+
31
+ ## Installation and usage
32
+ ### pip install
33
+
34
+ Install via [pip](https://pypi.org/project/pip/).
35
+
36
+ ```sh
37
+ pip install teamdbapi
38
+ ```
39
+
40
+ Then import the package:
41
+ ```python
42
+ import teamdbapi
43
+ ```
44
+
45
+ ## Getting Started
46
+
47
+ Please follow the installation procedure above and then, depending your TeamDB WebApi configuration, try the following :
48
+
49
+ ### Using the HTTP protocole
50
+
51
+ ```python
52
+ import teamdbapi
53
+ from teamdbapi.rest import ApiException
54
+
55
+ # Create a Configuration object
56
+ configuration = teamdbapi.Configuration()
57
+ configuration.host = "http://localhost:9001" # Replace with your TeamDB API address if different
58
+
59
+ # Create an instance of the Client API
60
+ client_api = teamdbapi.ApiClient(configuration)
61
+
62
+ # Create an instance of the Assembly API using the client_api
63
+ assembly_api = teamdbapi.AssemblyApi(client_api)
64
+
65
+ # Try to execute the request
66
+ try:
67
+
68
+ # Retrieve and print the current assembly before modification
69
+ result = assembly_api.get_current_assembly()
70
+ print(result)
71
+
72
+ # Set the desired current assembly, and print the response details
73
+ result = assembly_api.select_current_assembly_with_http_info(assembly_id = "6189993b-ad4d-4c41-8268-8419a63e5554") # Replace with your own valid Assembly id.
74
+ print(result)
75
+
76
+ # Retrieve and print the current assembly after modification
77
+ result = assembly_api.get_current_assembly()
78
+ print(result)
79
+
80
+ except ApiException as e:
81
+ print("Exception when selecting the current assembly : %s\n" % e)
82
+ ```
83
+
84
+ ### Using the HTTPS protocole
85
+
86
+ ```python
87
+ import teamdbapi
88
+ from teamdbapi.rest import ApiException
89
+
90
+ # Create a Configuration object
91
+ configuration = teamdbapi.Configuration()
92
+ configuration.host = "https://localhost:9001" # Replace with your TeamDB API address if different
93
+ configuration.api_key['TDB_API_Key'] = 'user_token' # Replace {user_token} by a valid TeamDB WebApi user token.
94
+
95
+ # Create an instance of the Client API
96
+ client_api = teamdbapi.ApiClient(configuration)
97
+
98
+ # Create an instance of the Assembly API using the client_api
99
+ assembly_api = teamdbapi.AssemblyApi(client_api)
100
+
101
+ # Try to execute the request
102
+ try:
103
+
104
+ # Retrieve and print the current assembly before modification
105
+ result = assembly_api.get_current_assembly()
106
+ print(result)
107
+
108
+ # Set the desired current assembly, and print the response details
109
+ result = assembly_api.select_current_assembly_with_http_info(assembly_id = "6189993b-ad4d-4c41-8268-8419a63e5554") # Replace with your own valid Assembly id.
110
+ print(result)
111
+
112
+ # Retrieve and print the current assembly after modification
113
+ result = assembly_api.get_current_assembly()
114
+ print(result)
115
+
116
+ except ApiException as e:
117
+ print("Exception when selecting the current assembly : %s\n" % e)
118
+ ```
119
+
120
+ **_NOTE:_** Each method has a detailed version (for example: select_current_assembly => select_current_assembly_with_http_info). This can be useful, for example, if you want to retrieve a detailed response: content, HTTP status code, HTTP header.
121
+
122
+ ## Documentation for API Endpoints
123
+
124
+ With a TeamDB Client, check the documentation at *http://localhost:9001* (Default value for the TeamDB Web API URL)
125
+
126
+ ## Documentation For Authorization
127
+
128
+ Endpoints are subject to the same authorization as in TeamDB.
129
+
130
+ ## Author
131
+
132
+ Trackside Software
133
+ support@trackside.fr
134
+
135
+