@withgateway/sdk 0.1.19 → 0.2.0

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 (130) hide show
  1. package/README.md +141 -2
  2. package/dist/cli.js +8677 -1320
  3. package/dist/cli.js.map +1 -1
  4. package/dist/cli.mjs +8683 -1327
  5. package/dist/cli.mjs.map +1 -1
  6. package/dist/index.d.mts +1 -1
  7. package/dist/index.d.ts +1 -1
  8. package/dist/index.js +1005 -55
  9. package/dist/index.js.map +1 -1
  10. package/dist/index.mjs +969 -47
  11. package/dist/index.mjs.map +1 -1
  12. package/dist/tracing/index.js +9 -2
  13. package/dist/tracing/index.js.map +1 -1
  14. package/dist/tracing/index.mjs +9 -2
  15. package/dist/tracing/index.mjs.map +1 -1
  16. package/dist/worlds/index.d.mts +738 -28
  17. package/dist/worlds/index.d.ts +738 -28
  18. package/dist/worlds/index.js +966 -51
  19. package/dist/worlds/index.js.map +1 -1
  20. package/dist/worlds/index.mjs +960 -45
  21. package/dist/worlds/index.mjs.map +1 -1
  22. package/package.json +9 -2
  23. package/runtime/gatewaysdk/__init__.py +0 -0
  24. package/runtime/gatewaysdk/environment/__init__.py +108 -0
  25. package/runtime/gatewaysdk/environment/_bundle.py +281 -0
  26. package/runtime/gatewaysdk/environment/_harbor.py +276 -0
  27. package/runtime/gatewaysdk/environment/_materialize.py +97 -0
  28. package/runtime/gatewaysdk/environment/_tar.py +33 -0
  29. package/runtime/gatewaysdk/environment/_world.py +346 -0
  30. package/runtime/gatewaysdk/environment/core.py +527 -0
  31. package/runtime/gatewaysdk/environment/errors.py +58 -0
  32. package/runtime/gatewaysdk/environment/runtime.py +150 -0
  33. package/runtime/gatewaysdk/environment/schema/__init__.py +35 -0
  34. package/runtime/gatewaysdk/environment/schema/__main__.py +225 -0
  35. package/runtime/gatewaysdk/environment/schema/_slack_fidelity.py +116 -0
  36. package/runtime/gatewaysdk/environment/schema/_slack_scenario.py +183 -0
  37. package/runtime/gatewaysdk/environment/schema/api.py +1628 -0
  38. package/runtime/gatewaysdk/environment/schema/batch.py +755 -0
  39. package/runtime/gatewaysdk/environment/schema/compiler.py +615 -0
  40. package/runtime/gatewaysdk/environment/schema/conform.py +428 -0
  41. package/runtime/gatewaysdk/environment/schema/connector.py +777 -0
  42. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/handlers.py +17 -0
  43. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/parity.json +28 -0
  44. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/provenance.json +233 -0
  45. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scope.toml +112 -0
  46. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/world.json +1380 -0
  47. package/runtime/gatewaysdk/environment/schema/connectors/base.json +28 -0
  48. package/runtime/gatewaysdk/environment/schema/connectors/custom/handlers.py +18 -0
  49. package/runtime/gatewaysdk/environment/schema/connectors/custom/world.json +123 -0
  50. package/runtime/gatewaysdk/environment/schema/connectors/github/handlers.py +81 -0
  51. package/runtime/gatewaysdk/environment/schema/connectors/github/parity.json +37 -0
  52. package/runtime/gatewaysdk/environment/schema/connectors/github/provenance.json +134 -0
  53. package/runtime/gatewaysdk/environment/schema/connectors/github/scope.toml +158 -0
  54. package/runtime/gatewaysdk/environment/schema/connectors/github/world.json +5869 -0
  55. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/handlers.py +23 -0
  56. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/world.json +209 -0
  57. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/handlers.py +18 -0
  58. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/world.json +286 -0
  59. package/runtime/gatewaysdk/environment/schema/connectors/jamf/handlers.py +34 -0
  60. package/runtime/gatewaysdk/environment/schema/connectors/jamf/parity.json +49 -0
  61. package/runtime/gatewaysdk/environment/schema/connectors/jamf/provenance.json +181 -0
  62. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scope.toml +128 -0
  63. package/runtime/gatewaysdk/environment/schema/connectors/jamf/world.json +2218 -0
  64. package/runtime/gatewaysdk/environment/schema/connectors/jira/handlers.py +28 -0
  65. package/runtime/gatewaysdk/environment/schema/connectors/jira/world.json +389 -0
  66. package/runtime/gatewaysdk/environment/schema/connectors/kandji/handlers.py +38 -0
  67. package/runtime/gatewaysdk/environment/schema/connectors/kandji/parity.json +29 -0
  68. package/runtime/gatewaysdk/environment/schema/connectors/kandji/provenance.json +152 -0
  69. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scope.toml +120 -0
  70. package/runtime/gatewaysdk/environment/schema/connectors/kandji/world.json +765 -0
  71. package/runtime/gatewaysdk/environment/schema/connectors/linear/handlers.py +20 -0
  72. package/runtime/gatewaysdk/environment/schema/connectors/linear/world.json +363 -0
  73. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/fidelity.json +45 -0
  74. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/handlers.py +1 -0
  75. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/provenance.json +851 -0
  76. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scope.md +231 -0
  77. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/teams-types.json +1710 -0
  78. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/world.json +858 -0
  79. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/handlers.py +32 -0
  80. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/parity.json +50 -0
  81. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/provenance.json +137 -0
  82. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scope.toml +78 -0
  83. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/world.json +16243 -0
  84. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/handlers.py +806 -0
  85. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/parity.json +46 -0
  86. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/provenance.json +143 -0
  87. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scope.toml +174 -0
  88. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/world.json +4695 -0
  89. package/runtime/gatewaysdk/environment/schema/connectors/slack/MODEL.md +236 -0
  90. package/runtime/gatewaysdk/environment/schema/connectors/slack/capabilities.json +1039 -0
  91. package/runtime/gatewaysdk/environment/schema/connectors/slack/handlers.py +762 -0
  92. package/runtime/gatewaysdk/environment/schema/connectors/slack/parity.json +65 -0
  93. package/runtime/gatewaysdk/environment/schema/connectors/slack/provenance.json +294 -0
  94. package/runtime/gatewaysdk/environment/schema/connectors/slack/scope.toml +44 -0
  95. package/runtime/gatewaysdk/environment/schema/connectors/slack/world.json +4993 -0
  96. package/runtime/gatewaysdk/environment/schema/connectors/workday/handlers.py +75 -0
  97. package/runtime/gatewaysdk/environment/schema/connectors/workday/parity.json +36 -0
  98. package/runtime/gatewaysdk/environment/schema/connectors/workday/provenance.json +179 -0
  99. package/runtime/gatewaysdk/environment/schema/connectors/workday/scope.toml +180 -0
  100. package/runtime/gatewaysdk/environment/schema/connectors/workday/world.json +806 -0
  101. package/runtime/gatewaysdk/environment/schema/data.py +593 -0
  102. package/runtime/gatewaysdk/environment/schema/extract.py +263 -0
  103. package/runtime/gatewaysdk/environment/schema/host.py +2407 -0
  104. package/runtime/gatewaysdk/environment/schema/host_surfaces.py +275 -0
  105. package/runtime/gatewaysdk/environment/schema/platform.py +1272 -0
  106. package/runtime/gatewaysdk/environment/schema/scaffold.py +250 -0
  107. package/runtime/gatewaysdk/environment/schema/skill.py +118 -0
  108. package/runtime/gatewaysdk/environment/schema/skills/agents/connector-template-author.md +202 -0
  109. package/runtime/gatewaysdk/environment/schema/skills/connector-schema-authoring/CONNECTORS.md +331 -0
  110. package/runtime/gatewaysdk/environment/schema/skills/connector-schema-authoring/CONVENTIONS.md +100 -0
  111. package/runtime/gatewaysdk/environment/schema/skills/connector-schema-authoring/SKILL.md +313 -0
  112. package/runtime/gatewaysdk/environment/schema/skills/world-data-ingestion/ROWS.md +223 -0
  113. package/runtime/gatewaysdk/environment/schema/skills/world-data-ingestion/SKILL.md +293 -0
  114. package/runtime/gatewaysdk/environment/schema/skills/worlds-getting-started/SKILL.md +390 -0
  115. package/runtime/gatewaysdk/environment/schema/slack.py +757 -0
  116. package/runtime/gatewaysdk/environment/schema/snapshot.py +479 -0
  117. package/runtime/gatewaysdk/environment/schema/store.py +904 -0
  118. package/runtime/gatewaysdk/environment/schema/tasks.py +525 -0
  119. package/runtime/gatewaysdk/environment/schema/tools_world.py +322 -0
  120. package/runtime/gatewaysdk/environment/schema/validation.py +577 -0
  121. package/runtime/gatewaysdk/environment/schema/worker.py +78 -0
  122. package/runtime/gatewaysdk/environment/schema/workers.py +500 -0
  123. package/runtime/gatewaysdk/environment/schema/world_tests.py +336 -0
  124. package/skills/agents/connector-template-author.md +202 -0
  125. package/skills/connector-schema-authoring/CONNECTORS.md +331 -0
  126. package/skills/connector-schema-authoring/CONVENTIONS.md +100 -0
  127. package/skills/connector-schema-authoring/SKILL.md +313 -0
  128. package/skills/world-data-ingestion/ROWS.md +223 -0
  129. package/skills/world-data-ingestion/SKILL.md +293 -0
  130. package/skills/worlds-getting-started/SKILL.md +390 -0
@@ -0,0 +1,806 @@
1
+ """Salesforce world tools; every mutation goes through the schema store.
2
+
3
+ Errors are raised in the vendor's shape: a JSON array of
4
+ ``{"message", "errorCode", "fields"}`` objects, as documented under
5
+ "Status Codes and Error Responses" in the REST API Developer Guide. The
6
+ error codes are the ones the SOAP API's StatusCode enumeration defines;
7
+ provenance.json lists which handler raises which.
8
+ """
9
+
10
+ import json
11
+ import re
12
+
13
+ from gateway_env import store, tool
14
+
15
+ #: The API version the pinned documentation describes (Winter '27).
16
+ API_VERSION = "v68.0"
17
+
18
+ #: SOQL object name -> entity. Standard objects only; a bound org's custom
19
+ #: objects arrive through describe-on-bind and extend this map with the world.
20
+ OBJECTS = {
21
+ "Account": "sf_accounts",
22
+ "Case": "sf_cases",
23
+ "Contact": "sf_contacts",
24
+ "Lead": "sf_leads",
25
+ "Opportunity": "sf_opportunities",
26
+ "Task": "sf_tasks",
27
+ "User": "sf_users",
28
+ }
29
+
30
+ #: Field names per entity, in world.json order, so SELECT resolves a column
31
+ #: name against an empty table. Keep in step with the entity schemas.
32
+ FIELDS = {
33
+ "sf_users": (
34
+ "Id",
35
+ "AboutMe",
36
+ "AccountId",
37
+ "Address",
38
+ "Alias",
39
+ "BadgeText",
40
+ "BannerPhotoUrl",
41
+ "CallCenterId",
42
+ "City",
43
+ "CommunityNickname",
44
+ "CompanyName",
45
+ "ContactId",
46
+ "Country",
47
+ "CountryCode",
48
+ "CurrentStatus",
49
+ "DefaultCurrencyIsoCode",
50
+ "DefaultDivision",
51
+ "DefaultGroupNotificationFrequency",
52
+ "DelegatedApproverId",
53
+ "Department",
54
+ "DigestFrequency",
55
+ "Division",
56
+ "Email",
57
+ "EmailEncodingKey",
58
+ "EmailPreferencesAutoBcc",
59
+ "EmployeeNumber",
60
+ "EndDay",
61
+ "Extension",
62
+ "Fax",
63
+ "FederationIdentifier",
64
+ "FirstName",
65
+ "ForecastEnabled",
66
+ "FullPhotoUrl",
67
+ "GeocodeAccuracy",
68
+ "HasUserVerifiedEmail",
69
+ "HasUserVerifiedPhone",
70
+ "IndividualId",
71
+ "IsActive",
72
+ "IsPartner",
73
+ "IsPortalEnabled",
74
+ "IsPortalSelfRegistered",
75
+ "IsPrmSuperUser",
76
+ "IsProfilePhotoActive",
77
+ "JigsawImportLimitOverride",
78
+ "LanguageLocaleKey",
79
+ "LastLoginDate",
80
+ "LastName",
81
+ "LastReferencedDate",
82
+ "LastViewedDate",
83
+ "Latitude",
84
+ "LocaleSidKey",
85
+ "Longitude",
86
+ "Manager",
87
+ "ManagerId",
88
+ "MediumBannerPhotoUrl",
89
+ "MiddleName",
90
+ "MobilePhone",
91
+ "Name",
92
+ "NumberOfFailedLogins",
93
+ "OfflineTrialExpirationDate",
94
+ "PasswordExpirationDate",
95
+ "Phone",
96
+ "PortalRole",
97
+ "PostalCode",
98
+ "ProfileId",
99
+ "ReceivesAdminInfoEmails",
100
+ "ReceivesInfoEmails",
101
+ "SenderEmail",
102
+ "SenderName",
103
+ "Signature",
104
+ "SmallBannerPhotoUrl",
105
+ "SmallPhotoUrl",
106
+ "StartDay",
107
+ "State",
108
+ "StateCode",
109
+ "Street",
110
+ "SuAccessExpirationDate",
111
+ "Suffix",
112
+ "TimeZoneSidKey",
113
+ "Title",
114
+ "Username",
115
+ "UserPermissionsCallCenterAutoLogin",
116
+ "UserPermissionsChatterAnswersUser",
117
+ "UserPermissionsInteractionUser",
118
+ "UserPermissionsJigsawProspectingUser",
119
+ "UserPermissionsKnowledgeUser",
120
+ "UserPermissionsLiveAgentUser",
121
+ "UserPermissionsMarketingUser",
122
+ "UserPermissionsOfflineUser",
123
+ "UserPermissionsSFContentUser",
124
+ "UserPermissionsSiteforceContributorUser",
125
+ "UserPermissionsSiteforcePublisherUser",
126
+ "UserPermissionsSupportUser",
127
+ "UserPermissionsWirelessUser",
128
+ "UserPermissionsWorkDotComUserFeature",
129
+ "UserPreferencesActivityRemindersPopup",
130
+ "UserPreferencesAgentGdprConsent",
131
+ "UserPreferencesAllowConversationReminders",
132
+ "UserPreferencesApexPagesDeveloperMode",
133
+ "UserPreferencesAutoForwardCall",
134
+ "UserPreferencesContentEmailAsAndWhen",
135
+ "UserPreferencesContentNoEmail",
136
+ "UserPreferencesEnableAutoSubForFeeds",
137
+ "UserPreferencesDisableAllFeedsEmail",
138
+ "UserPreferencesDisableAutoSubForFeeds",
139
+ "UserPreferencesDisableBookmarkEmail",
140
+ "UserPreferencesDisableChangeCommentEmail",
141
+ "UserPreferencesDisableEndorsementEmail",
142
+ "UserPreferencesDisableFileShareNotificationsForApi",
143
+ "UserPreferencesDisableFollowersEmail",
144
+ "UserPreferencesDisableLaterCommentEmail",
145
+ "UserPreferencesDisableLikeEmail",
146
+ "UserPreferencesDisableMentionsPostEmail",
147
+ "UserPreferencesDisableProfilePostEmail",
148
+ "UserPreferencesDisableSharePostEmail",
149
+ "UserPreferencesDisableFeedbackEmail",
150
+ "UserPreferencesDisCommentAfterLikeEmail",
151
+ "UserPreferencesDisMentionsCommentEmail",
152
+ "UserPreferencesDisableMessageEmail",
153
+ "UserPreferencesDisableRewardEmail",
154
+ "UserPreferencesDisableWorkEmail",
155
+ "UserPreferencesDisProfPostCommentEmail",
156
+ "UserPreferencesEnableVoiceCallRecording",
157
+ "UserPreferencesEnableVoiceLocalPresence",
158
+ "UserPreferencesEventRemindersCheckboxDefault",
159
+ "UserPreferencesHideBiggerPhotoCallout",
160
+ "UserPreferencesHideChatterOnboardingSplash",
161
+ "UserPreferencesHideCSNDesktopTask",
162
+ "UserPreferencesHideCSNGetChatterMobileTask",
163
+ "UserPreferencesHideEndUserOnboardingAssistantModal",
164
+ "UserPreferencesHideLightningMigrationModal",
165
+ "UserPreferencesHideSecondChatterOnboardingSplash",
166
+ "UserPreferencesHideS1BrowserUI",
167
+ "UserPreferencesHideSfxWelcomeMat",
168
+ "UserPreferencesJigsawListUser",
169
+ "UserPreferencesLightningExperiencePreferred",
170
+ "UserPreferencesLiveAgentMiawSetupDeflection",
171
+ "UserPreferencesNativeEmailClient",
172
+ "UserPreferencesOptOutOfTouch",
173
+ "UserPreferencesOutboundBridge",
174
+ "UserPreferencesPathAssistantCollapsed",
175
+ "UserPreferencesProcessAssistantCollapsed",
176
+ "UserPreferencesReceiveNoNotificationsAsApprover",
177
+ "UserPreferencesReceiveNotificationsAsDelegatedApprover",
178
+ "UserPreferencesReminderSoundOff",
179
+ "UserPreferencesShowCityToExternalUsers",
180
+ "UserPreferencesShowCityToGuestUsers",
181
+ "UserPreferencesShowCountryToExternalUsers",
182
+ "UserPreferencesShowCountryToGuestUsers",
183
+ "UserPreferencesShowEmailToExternalUsers",
184
+ "UserPreferencesShowEmailToGuestUsers",
185
+ "UserPreferencesShowFaxToExternalUsers",
186
+ "UserPreferencesShowFaxToGuestUsers",
187
+ "UserPreferencesShowManagerToExternalUsers",
188
+ "UserPreferencesShowManagerToGuestUsers",
189
+ "UserPreferencesShowMobilePhoneToExternalUsers",
190
+ "UserPreferencesShowMobilePhoneToGuestUsers",
191
+ "UserPreferencesShowPostalCodeToExternalUsers",
192
+ "UserPreferencesShowPostalCodeToGuestUsers",
193
+ "UserPreferencesShowProfilePicToGuestUsers",
194
+ "UserPreferencesShowStateToExternalUsers",
195
+ "UserPreferencesShowStateToGuestUsers",
196
+ "UserPreferencesShowStreetAddressToExternalUsers",
197
+ "UserPreferencesShowStreetAddressToGuestUsers",
198
+ "UserPreferencesShowTitleToExternalUsers",
199
+ "UserPreferencesShowTitleToGuestUsers",
200
+ "UserPreferencesShowWorkPhoneToExternalUsers",
201
+ "UserPreferencesShowWorkPhoneToGuestUsers",
202
+ "UserPreferencesSortFeedByComment",
203
+ "UserPreferencesSuppressEventSFXReminders",
204
+ "UserPreferencesSuppressTaskSFXReminders",
205
+ "UserPreferencesTaskRemindersCheckboxDefault",
206
+ "UserPreferencesUserDebugModePref",
207
+ "UserRoleId",
208
+ "UserType",
209
+ "WirelessEmail",
210
+ ),
211
+ "sf_accounts": (
212
+ "Id",
213
+ "AccountNumber",
214
+ "AccountSource",
215
+ "ActivityMetricId",
216
+ "ActivityMetricRollupId",
217
+ "AnnualRevenue",
218
+ "BillingAddress",
219
+ "BillingCity",
220
+ "BillingCountry",
221
+ "BillingCountryCode",
222
+ "BillingGeocodeAccuracy",
223
+ "BillingLatitude",
224
+ "BillingLongitude",
225
+ "BillingPostalCode",
226
+ "BillingState",
227
+ "BillingStateCode",
228
+ "BillingStreet",
229
+ "ChannelProgramLevelName",
230
+ "ChannelProgramName",
231
+ "CleanStatus",
232
+ "CommerceCustomerReference",
233
+ "CommerceGroupReference",
234
+ "CommerceOrganizationReference",
235
+ "ConnectionReceivedId",
236
+ "ConnectionSentId",
237
+ "Description",
238
+ "DunsNumber",
239
+ "Fax",
240
+ "Industry",
241
+ "IsBuyer",
242
+ "IsCustomerPortal",
243
+ "IsPartner",
244
+ "IsPersonAccount",
245
+ "IsPriorityRecord",
246
+ "Jigsaw",
247
+ "JigsawCompanyId",
248
+ "LastActivityDate",
249
+ "LastReferencedDate",
250
+ "LastViewedDate",
251
+ "MasterRecordId",
252
+ "NaicsCode",
253
+ "NaicsDesc",
254
+ "Name",
255
+ "NumberOfEmployees",
256
+ "OperatingHoursId",
257
+ "OwnerId",
258
+ "Ownership",
259
+ "ParentId",
260
+ "PersonActionCadenceAssigneeId",
261
+ "PersonActionCadenceId",
262
+ "PersonActionCadenceState",
263
+ "PersonIndividualId",
264
+ "PersonScheduledResumeDateTime",
265
+ "Phone",
266
+ "PhotoUrl",
267
+ "Rating",
268
+ "RecordTypeId",
269
+ "Salutation",
270
+ "ShippingAddress",
271
+ "ShippingCity",
272
+ "ShippingCountry",
273
+ "ShippingCountryCode",
274
+ "ShippingGeocodeAccuracy",
275
+ "ShippingLatitude",
276
+ "ShippingLongitude",
277
+ "ShippingPostalCode",
278
+ "ShippingState",
279
+ "ShippingStateCode",
280
+ "ShippingStreet",
281
+ "Sic",
282
+ "SicDesc",
283
+ "Site",
284
+ "TickerSymbol",
285
+ "Tradestyle",
286
+ "Type",
287
+ "Website",
288
+ "YearStarted",
289
+ "FirstName",
290
+ "LastName",
291
+ "MiddleName",
292
+ "PersonAssistantName",
293
+ "PersonAssistantPhone",
294
+ "PersonBirthDate",
295
+ "PersonContactId",
296
+ "PersonDepartment",
297
+ "PersonEmail",
298
+ "PersonEmailBouncedDate",
299
+ "PersonEmailBouncedReason",
300
+ "PersonGenderIdentity",
301
+ "PersonHasOptedOutOfEmail",
302
+ "PersonHomePhone",
303
+ "PersonLeadSource",
304
+ "PersonMailingAddress",
305
+ "PersonMailingCity",
306
+ "PersonMailingCountry",
307
+ "PersonMailingPostalCode",
308
+ "PersonMailingState",
309
+ "PersonMailingCountryCode",
310
+ "PersonMailingStateCode",
311
+ "PersonMailingGeocodeAccuracy",
312
+ "PersonMailingLatitude",
313
+ "PersonMailingLongitude",
314
+ "PersonMailingStreet",
315
+ "PersonMobilePhone",
316
+ "PersonOtherCity",
317
+ "PersonOtherCountry",
318
+ "PersonOtherPostalCode",
319
+ "PersonOtherState",
320
+ "PersonOtherCountryCode",
321
+ "PersonOtherStateCode",
322
+ "PersonOtherLatitude",
323
+ "PersonOtherLongitude",
324
+ "PersonOtherPhone",
325
+ "PersonOtherStreet",
326
+ "PersonPronouns",
327
+ "PersonReportsToId",
328
+ "PersonTitle",
329
+ "Suffix",
330
+ ),
331
+ "sf_contacts": (
332
+ "Id",
333
+ "AccountId",
334
+ "ActionCadenceAssigneeId",
335
+ "ActionCadenceId",
336
+ "ActionCadenceState",
337
+ "ActiveTrackerCount",
338
+ "ActivityMetricId",
339
+ "ActivityMetricRollupId",
340
+ "AssistantName",
341
+ "AssistantPhone",
342
+ "Birthdate",
343
+ "BuyerAttributes",
344
+ "CanAllowPortalSelfReg",
345
+ "CleanStatus",
346
+ "CommerceCustomerReference",
347
+ "CommerceGroupReference",
348
+ "CommerceOrganizationReference",
349
+ "ConnectionReceivedId",
350
+ "ConnectionSentId",
351
+ "ContactSource",
352
+ "Department",
353
+ "DepartmentGroup",
354
+ "Description",
355
+ "DoNotCall",
356
+ "Email",
357
+ "EmailBouncedDate",
358
+ "EmailBouncedReason",
359
+ "Fax",
360
+ "FirstCallDateTime",
361
+ "FirstEmailDateTime",
362
+ "FirstName",
363
+ "GenderIdentity",
364
+ "HasOptedOutOfEmail",
365
+ "HasOptedOutOfFax",
366
+ "HomePhone",
367
+ "IndividualId",
368
+ "IsDeleted",
369
+ "IsEmailBounced",
370
+ "IsPersonAccount",
371
+ "IsPriorityRecord",
372
+ "Jigsaw",
373
+ "JigsawContactId",
374
+ "LastActivityDate",
375
+ "LastName",
376
+ "LastReferencedDate",
377
+ "LastViewedDate",
378
+ "LeadSource",
379
+ "MailingAddress",
380
+ "MailingCity",
381
+ "MailingCountry",
382
+ "MailingCountryCode",
383
+ "MailingGeocodeAccuracy",
384
+ "MailingLatitude",
385
+ "MailingLongitude",
386
+ "MailingPostalCode",
387
+ "MailingState",
388
+ "MailingStateCode",
389
+ "MailingStreet",
390
+ "MasterRecordId",
391
+ "MiddleName",
392
+ "MobilePhone",
393
+ "Name",
394
+ "OtherAddress",
395
+ "OtherCity",
396
+ "OtherCountry",
397
+ "OtherCountryCode",
398
+ "OtherGeocodeAccuracy",
399
+ "OtherLatitude",
400
+ "OtherLongitude",
401
+ "OtherPhone",
402
+ "OtherPostalCode",
403
+ "OtherState",
404
+ "OtherStateCode",
405
+ "OtherStreet",
406
+ "OwnerId",
407
+ "Phone",
408
+ "PhotoUrl",
409
+ "Pronouns",
410
+ "RecordTypeId",
411
+ "ReportsToId",
412
+ "Salutation",
413
+ "ScheduledResumeDateTime",
414
+ "Suffix",
415
+ "Title",
416
+ "TitleType",
417
+ ),
418
+ "sf_leads": (
419
+ "Id",
420
+ "ActionCadenceAssigneeId",
421
+ "ActionCadenceId",
422
+ "ActionCadenceState",
423
+ "ActiveTrackerCount",
424
+ "ActivityMetricId",
425
+ "ActivityMetricRollupId",
426
+ "Address",
427
+ "AnnualRevenue",
428
+ "City",
429
+ "CleanStatus",
430
+ "Company",
431
+ "CompanyDunsNumber",
432
+ "ConvertedAccountId",
433
+ "ConvertedContactId",
434
+ "ConvertedDate",
435
+ "ConvertedOpportunityId",
436
+ "ConnectionReceivedId",
437
+ "ConnectionSentId",
438
+ "Country",
439
+ "CountryCode",
440
+ "CurrencyIsoCode",
441
+ "DandBCompanyId",
442
+ "Description",
443
+ "Division",
444
+ "Email",
445
+ "EmailBouncedDate",
446
+ "EmailBouncedReason",
447
+ "ExportStatus",
448
+ "Fax",
449
+ "FirstCallDateTime",
450
+ "FirstEmailDateTime",
451
+ "FirstName",
452
+ "GeocodeAccuracy",
453
+ "GenderIdentity",
454
+ "HasOptedOutOfEmail",
455
+ "HasOptedOutOfFax",
456
+ "IndividualId",
457
+ "Industry",
458
+ "IsConverted",
459
+ "IsDeleted",
460
+ "IsPriorityRecord",
461
+ "IsUnreadByOwner",
462
+ "Jigsaw",
463
+ "JigsawContactId",
464
+ "LastActivityDate",
465
+ "LastName",
466
+ "LastReferencedDate",
467
+ "LastViewedDate",
468
+ "Latitude",
469
+ "LeadSource",
470
+ "Longitude",
471
+ "MasterRecordId",
472
+ "MiddleName",
473
+ "MobilePhone",
474
+ "Name",
475
+ "NumberOfEmployees",
476
+ "OwnerId",
477
+ "PartnerAccountId",
478
+ "Phone",
479
+ "PhotoUrl",
480
+ "PostalCode",
481
+ "Pronouns",
482
+ "Rating",
483
+ "RecordTypeId",
484
+ "Salutation",
485
+ "ScheduledResumeDateTime",
486
+ "ScoreIntelligenceId",
487
+ "State",
488
+ "StateCode",
489
+ "Status",
490
+ "Street",
491
+ "Suffix",
492
+ "Title",
493
+ "Website",
494
+ ),
495
+ "sf_opportunities": (
496
+ "Id",
497
+ "AccountId",
498
+ "ActivityMetricId",
499
+ "ActivityMetricRollupId",
500
+ "AgeInDays",
501
+ "Amount",
502
+ "CampaignId",
503
+ "CloseDate",
504
+ "ConnectionReceivedId",
505
+ "ConnectionSentId",
506
+ "ContactId",
507
+ "ContractId",
508
+ "CurrencyIsoCode",
509
+ "Description",
510
+ "ExpectedRevenue",
511
+ "ExportStatus",
512
+ "Fiscal",
513
+ "FiscalQuarter",
514
+ "FiscalYear",
515
+ "ForecastCategory",
516
+ "ForecastCategoryName",
517
+ "HasOpenActivity",
518
+ "HasOpportunityLineItem",
519
+ "HasOverdueTask",
520
+ "IqScore",
521
+ "IsClosed",
522
+ "IsDeleted",
523
+ "IsExcludedFromTerritory2Filter",
524
+ "IsPriorityRecord",
525
+ "IsPrivate",
526
+ "IsSplit",
527
+ "IsWon",
528
+ "LastActivityDate",
529
+ "LastActivityInDays",
530
+ "LastAmountChangedHistoryId",
531
+ "LastCloseDateChangedHistoryId",
532
+ "LastReferencedDate",
533
+ "LastStageChangeDate",
534
+ "LastStageChangeInDays",
535
+ "LastViewedDate",
536
+ "LeadSource",
537
+ "Name",
538
+ "NextStep",
539
+ "OwnerId",
540
+ "PartnerAccountId",
541
+ "Pricebook2Id",
542
+ "PricebookId",
543
+ "Probability",
544
+ "PushCount",
545
+ "RecordTypeId",
546
+ "StageName",
547
+ "SyncedQuoteID",
548
+ "Territory2Id",
549
+ "TotalOpportunityQuantity",
550
+ "Type",
551
+ ),
552
+ "sf_cases": (
553
+ "Id",
554
+ "AccountId",
555
+ "AssetWarrantyID",
556
+ "BusinessHoursId",
557
+ "Comments",
558
+ "CaseNumber",
559
+ "ClosedDate",
560
+ "CommunityId",
561
+ "ConnectionReceivedId",
562
+ "ConnectionSentId",
563
+ "ContactEmail",
564
+ "ContactFax",
565
+ "ContactId",
566
+ "ContactMobile",
567
+ "ContactPhone",
568
+ "CreatorFullPhotoUrl",
569
+ "CreatorName",
570
+ "CreatorSmallPhotoUrl",
571
+ "Description",
572
+ "FeedItemId",
573
+ "HasCommentsUnreadByOwner",
574
+ "HasSelfServiceComments",
575
+ "IsClosed",
576
+ "IsClosedOnCreate",
577
+ "IsDeleted",
578
+ "IsEscalated",
579
+ "IsSelfServiceClosed",
580
+ "IsStopped",
581
+ "IsVisibleInSelfService",
582
+ "Language",
583
+ "LastReferencedDate",
584
+ "LastViewedDate",
585
+ "MasterRecordId",
586
+ "Origin",
587
+ "OwnerId",
588
+ "ParentId",
589
+ "Priority",
590
+ "QuestionId",
591
+ "Reason",
592
+ "RecordTypeId",
593
+ "ServiceContractId",
594
+ "SlaStartDate",
595
+ "SourceId",
596
+ "Status",
597
+ "StopStartDate",
598
+ "Subject",
599
+ "SuppliedCompany",
600
+ "SuppliedEmail",
601
+ "SuppliedName",
602
+ "SuppliedPhone",
603
+ "Type",
604
+ ),
605
+ "sf_tasks": (
606
+ "Id",
607
+ "AccountId",
608
+ "ActivityDate",
609
+ "CallDisposition",
610
+ "CallDurationInSeconds",
611
+ "CallObject",
612
+ "CallType",
613
+ "CompletedDateTime",
614
+ "ConnectionReceivedId",
615
+ "ConnectionSentId",
616
+ "Description",
617
+ "IsArchived",
618
+ "IsClosed",
619
+ "IsHighPriority",
620
+ "IsRecurrence",
621
+ "IsReminderSet",
622
+ "IsVisibleInSelfService",
623
+ "OwnerId",
624
+ "Priority",
625
+ "RecurrenceActivityId",
626
+ "RecurrenceDayOfMonth",
627
+ "RecurrenceDayOfWeekMask",
628
+ "RecurrenceEndDateOnly",
629
+ "RecurrenceInstance",
630
+ "RecurrenceInterval",
631
+ "RecurrenceMonthOfYear",
632
+ "RecurrenceRegeneratedType",
633
+ "RecurrenceStartDateOnly",
634
+ "RecurrenceTimeZoneSidKey",
635
+ "RecurrenceType",
636
+ "ReminderDateTime",
637
+ "Status",
638
+ "Subject",
639
+ "TaskSubtype",
640
+ "TaskWhoIds",
641
+ "Type",
642
+ "WhatCount",
643
+ "WhatId",
644
+ "WhoCount",
645
+ "WhoId",
646
+ ),
647
+ }
648
+
649
+ #: StageName drives IsWon and IsClosed; neither is directly settable.
650
+ WON = "Closed Won"
651
+ LOST = "Closed Lost"
652
+
653
+ QUERY = re.compile(
654
+ r"""\s*SELECT\s+(?P<fields>[^;]+?)
655
+ \s+FROM\s+(?P<object>[A-Za-z][A-Za-z0-9_]*)
656
+ (?:\s+WHERE\s+(?P<where>.+?))?
657
+ (?:\s+ORDER\s+BY\s+(?P<order>[A-Za-z][A-Za-z0-9_]*)(?:\s+(?P<direction>ASC|DESC))?)?
658
+ (?:\s+LIMIT\s+(?P<limit>\d+))?
659
+ \s*$""",
660
+ re.IGNORECASE | re.VERBOSE | re.DOTALL,
661
+ )
662
+ CONDITION = re.compile(r"^(?P<field>[A-Za-z][A-Za-z0-9_]*)\s*(?P<operator>!=|<=|>=|=|<|>)\s*(?P<literal>.+)$")
663
+ COMPARISONS = {
664
+ "=": lambda a, b: a == b,
665
+ "!=": lambda a, b: a != b,
666
+ "<": lambda a, b: _ordered(a, b) < 0,
667
+ "<=": lambda a, b: _ordered(a, b) <= 0,
668
+ ">": lambda a, b: _ordered(a, b) > 0,
669
+ ">=": lambda a, b: _ordered(a, b) >= 0,
670
+ }
671
+
672
+
673
+ def error(code, message, fields=()):
674
+ """The vendor's error body, verbatim in shape."""
675
+ return ValueError(json.dumps([{"message": message, "errorCode": code, "fields": list(fields)}]))
676
+
677
+
678
+ def _rank(value):
679
+ """Order NULL first, then booleans, numbers and text, as SOQL sorts."""
680
+ if value is None:
681
+ return (0, 0, "")
682
+ if isinstance(value, bool):
683
+ return (1, int(value), "")
684
+ if isinstance(value, (int, float)):
685
+ return (2, value, "")
686
+ return (3, 0, str(value))
687
+
688
+
689
+ def _ordered(left, right):
690
+ a, b = _rank(left), _rank(right)
691
+ return (a > b) - (a < b)
692
+
693
+
694
+ def _derive(stage):
695
+ return {"IsClosed": stage in (WON, LOST), "IsWon": stage == WON}
696
+
697
+
698
+ def _reference(entity, value, field):
699
+ if value is not None and store.get(entity, {"Id": value}) is None:
700
+ raise error(
701
+ "INVALID_CROSS_REFERENCE_KEY",
702
+ f"invalid cross reference id: {value}",
703
+ [field],
704
+ )
705
+
706
+
707
+ @tool(name="list_opportunities")
708
+ def list_opportunities(AccountId):
709
+ return [o for o in store.list("sf_opportunities") if o.get("AccountId") == AccountId]
710
+
711
+
712
+ @tool(name="create_opportunity")
713
+ def create_opportunity(opportunity):
714
+ _reference("sf_accounts", opportunity.get("AccountId"), "AccountId")
715
+ _reference("sf_users", opportunity.get("OwnerId"), "OwnerId")
716
+ record = {**opportunity, **_derive(opportunity["StageName"])}
717
+ return store.insert("sf_opportunities", record, source={"record": "tool.create_opportunity"})
718
+
719
+
720
+ @tool(name="update_stage")
721
+ def update_stage(Id, StageName):
722
+ if store.get("sf_opportunities", {"Id": Id}) is None:
723
+ raise error("NOT_FOUND", "The requested resource does not exist", ["Id"])
724
+ return store.update(
725
+ "sf_opportunities",
726
+ {"Id": Id},
727
+ {"StageName": StageName, **_derive(StageName)},
728
+ source={"record": "tool.update_stage"},
729
+ )
730
+
731
+
732
+ @tool(name="query_records")
733
+ def query_records(soql):
734
+ """SELECT fields FROM object [WHERE ...] [ORDER BY field [ASC|DESC]] [LIMIT n]."""
735
+ parsed = QUERY.match(soql)
736
+ if parsed is None:
737
+ raise error("MALFORMED_QUERY", "An invalid query string was specified")
738
+ name = _object(parsed.group("object"))
739
+ known = {field.lower(): field for field in FIELDS[OBJECTS[name]]}
740
+ fields = [_field(known, f) for f in parsed.group("fields").split(",")]
741
+ rows = store.list(OBJECTS[name])
742
+ for condition in _conditions(parsed.group("where")):
743
+ rows = [row for row in rows if _matches(known, row, condition)]
744
+ if parsed.group("order"):
745
+ rows.sort(
746
+ key=lambda row: _rank(row.get(_field(known, parsed.group("order")))),
747
+ reverse=(parsed.group("direction") or "ASC").upper() == "DESC",
748
+ )
749
+ if parsed.group("limit"):
750
+ rows = rows[: int(parsed.group("limit"))]
751
+ records = [
752
+ {
753
+ "attributes": {
754
+ "type": name,
755
+ "url": f"/services/data/{API_VERSION}/sobjects/{name}/{row['Id']}",
756
+ },
757
+ **{field: row.get(field) for field in fields},
758
+ }
759
+ for row in rows
760
+ ]
761
+ return {"totalSize": len(records), "done": True, "records": records}
762
+
763
+
764
+ def _object(name):
765
+ for candidate in OBJECTS:
766
+ if candidate.lower() == name.lower():
767
+ return candidate
768
+ raise error("INVALID_TYPE", f"sObject type '{name}' is not supported")
769
+
770
+
771
+ def _field(known, name):
772
+ field = known.get(name.strip().lower())
773
+ if field is None:
774
+ raise error("INVALID_FIELD", f"No such column '{name.strip()}'", [name.strip()])
775
+ return field
776
+
777
+
778
+ def _conditions(where):
779
+ if not where:
780
+ return []
781
+ parsed = []
782
+ for clause in re.split(r"\s+AND\s+", where.strip(), flags=re.IGNORECASE):
783
+ match = CONDITION.match(clause.strip())
784
+ if match is None:
785
+ raise error("MALFORMED_QUERY", "An invalid query string was specified")
786
+ parsed.append((match.group("field"), match.group("operator"), _literal(match.group("literal"))))
787
+ return parsed
788
+
789
+
790
+ def _literal(text):
791
+ text = text.strip()
792
+ if len(text) >= 2 and text[0] == "'" and text[-1] == "'":
793
+ return text[1:-1]
794
+ if text.upper() == "NULL":
795
+ return None
796
+ if text.upper() in ("TRUE", "FALSE"):
797
+ return text.upper() == "TRUE"
798
+ try:
799
+ return int(text) if re.fullmatch(r"-?\d+", text) else float(text)
800
+ except ValueError:
801
+ raise error("MALFORMED_QUERY", "An invalid query string was specified") from None
802
+
803
+
804
+ def _matches(known, row, condition):
805
+ field, operator, literal = condition
806
+ return COMPARISONS[operator](row.get(_field(known, field)), literal)