appnigma-sdk 2.0.0 → 2.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 (168) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +14 -0
  3. data/README.md +592 -26
  4. data/exe/appnigma +8 -0
  5. data/lib/appnigma/actions.rb +33 -0
  6. data/lib/appnigma/checks.rb +13 -0
  7. data/lib/appnigma/client.rb +30 -13
  8. data/lib/appnigma/command.rb +154 -0
  9. data/lib/appnigma/command_files.rb +46 -0
  10. data/lib/appnigma/connect_fields.rb +83 -0
  11. data/lib/appnigma/connections.rb +72 -3
  12. data/lib/appnigma/constants.rb +57 -0
  13. data/lib/appnigma/end_customers.rb +29 -0
  14. data/lib/appnigma/errors.rb +44 -6
  15. data/lib/appnigma/features.rb +19 -0
  16. data/lib/appnigma/files.rb +26 -0
  17. data/lib/appnigma/generated/api/default_api.rb +2149 -380
  18. data/lib/appnigma/generated/api_client.rb +1 -1
  19. data/lib/appnigma/generated/api_error.rb +1 -1
  20. data/lib/appnigma/generated/api_model_base.rb +1 -1
  21. data/lib/appnigma/generated/configuration.rb +1 -1
  22. data/lib/appnigma/generated/models/action_entry.rb +1 -1
  23. data/lib/appnigma/generated/models/check_logic_input.rb +276 -0
  24. data/lib/appnigma/generated/models/check_logic_output.rb +193 -0
  25. data/lib/appnigma/generated/models/client_event.rb +309 -0
  26. data/lib/appnigma/generated/models/client_event_delivery.rb +306 -0
  27. data/lib/appnigma/generated/models/client_event_type.rb +44 -0
  28. data/lib/appnigma/generated/models/client_webhook.rb +346 -0
  29. data/lib/appnigma/generated/models/connect_end_customer_input.rb +243 -0
  30. data/lib/appnigma/generated/models/connect_end_customer_output.rb +294 -0
  31. data/lib/appnigma/generated/models/connect_field.rb +308 -0
  32. data/lib/appnigma/generated/models/connection_status.rb +1 -1
  33. data/lib/appnigma/generated/models/create_connection_link_input.rb +1 -1
  34. data/lib/appnigma/generated/models/create_connection_link_output.rb +1 -1
  35. data/lib/appnigma/generated/models/create_logic_input.rb +273 -0
  36. data/lib/appnigma/generated/models/create_logic_input_trigger.rb +104 -0
  37. data/lib/appnigma/generated/models/create_logic_input_trigger_any_of.rb +257 -0
  38. data/lib/appnigma/generated/models/create_logic_input_trigger_any_of1.rb +238 -0
  39. data/lib/appnigma/generated/models/create_logic_output.rb +230 -0
  40. data/lib/appnigma/generated/models/create_portal_link_input.rb +2 -18
  41. data/lib/appnigma/generated/models/create_portal_link_output.rb +1 -1
  42. data/lib/appnigma/generated/models/create_webhook_input.rb +187 -0
  43. data/lib/appnigma/generated/models/create_webhook_output.rb +204 -0
  44. data/lib/appnigma/generated/models/crm_company.rb +1 -1
  45. data/lib/appnigma/generated/models/crm_company_get_output.rb +1 -1
  46. data/lib/appnigma/generated/models/crm_company_list_output.rb +1 -1
  47. data/lib/appnigma/generated/models/crm_company_write_output.rb +1 -1
  48. data/lib/appnigma/generated/models/crm_contact.rb +1 -1
  49. data/lib/appnigma/generated/models/crm_contact_get_output.rb +1 -1
  50. data/lib/appnigma/generated/models/crm_contact_list_output.rb +1 -1
  51. data/lib/appnigma/generated/models/crm_contact_write_output.rb +1 -1
  52. data/lib/appnigma/generated/models/crm_create_input.rb +1 -1
  53. data/lib/appnigma/generated/models/crm_custom_field.rb +1 -1
  54. data/lib/appnigma/generated/models/crm_deal.rb +1 -1
  55. data/lib/appnigma/generated/models/crm_deal_create_input.rb +1 -1
  56. data/lib/appnigma/generated/models/crm_deal_get_output.rb +1 -1
  57. data/lib/appnigma/generated/models/crm_deal_list_output.rb +1 -1
  58. data/lib/appnigma/generated/models/crm_deal_write_output.rb +1 -1
  59. data/lib/appnigma/generated/models/crm_email.rb +1 -1
  60. data/lib/appnigma/generated/models/crm_get_input.rb +1 -1
  61. data/lib/appnigma/generated/models/crm_labelled.rb +1 -1
  62. data/lib/appnigma/generated/models/crm_list_input.rb +1 -1
  63. data/lib/appnigma/generated/models/crm_phone.rb +1 -1
  64. data/lib/appnigma/generated/models/crm_update_input.rb +1 -1
  65. data/lib/appnigma/generated/models/delete_end_customer_input.rb +178 -0
  66. data/lib/appnigma/generated/models/delete_end_customer_output.rb +286 -0
  67. data/lib/appnigma/generated/models/delete_end_customer_output_connections_inner.rb +238 -0
  68. data/lib/appnigma/generated/models/delete_end_customer_output_logic_folder.rb +255 -0
  69. data/lib/appnigma/generated/models/delete_end_customer_output_steps_inner.rb +257 -0
  70. data/lib/appnigma/generated/models/delete_webhook_input.rb +189 -0
  71. data/lib/appnigma/generated/models/delete_webhook_output.rb +228 -0
  72. data/lib/appnigma/generated/models/discard_logic_input.rb +292 -0
  73. data/lib/appnigma/generated/models/discard_logic_output.rb +254 -0
  74. data/lib/appnigma/generated/models/disconnect_connection_input.rb +216 -0
  75. data/lib/appnigma/generated/models/disconnect_connection_output.rb +294 -0
  76. data/lib/appnigma/generated/models/edit_logic_input.rb +368 -0
  77. data/lib/appnigma/generated/models/edit_logic_output.rb +298 -0
  78. data/lib/appnigma/generated/models/encrypted_fields.rb +357 -0
  79. data/lib/appnigma/generated/models/end_customer.rb +17 -3
  80. data/lib/appnigma/generated/models/end_customer_connection.rb +1 -1
  81. data/lib/appnigma/generated/models/function_entry.rb +1 -1
  82. data/lib/appnigma/generated/models/function_owner.rb +1 -1
  83. data/lib/appnigma/generated/models/function_owner_one_of.rb +1 -1
  84. data/lib/appnigma/generated/models/function_owner_one_of1.rb +1 -1
  85. data/lib/appnigma/generated/models/get_alerts_output.rb +180 -0
  86. data/lib/appnigma/generated/models/get_connect_key_output.rb +256 -0
  87. data/lib/appnigma/generated/models/get_connection_input.rb +1 -1
  88. data/lib/appnigma/generated/models/get_connection_output.rb +34 -7
  89. data/lib/appnigma/generated/models/get_guide_output.rb +1 -1
  90. data/lib/appnigma/generated/models/get_logic_go_live_status_input.rb +247 -0
  91. data/lib/appnigma/generated/models/get_logic_go_live_status_output.rb +296 -0
  92. data/lib/appnigma/generated/models/get_logic_input.rb +247 -0
  93. data/lib/appnigma/generated/models/get_logic_output.rb +240 -0
  94. data/lib/appnigma/generated/models/get_logic_output_file.rb +204 -0
  95. data/lib/appnigma/generated/models/get_platform_input.rb +188 -0
  96. data/lib/appnigma/generated/models/get_platform_output.rb +326 -0
  97. data/lib/appnigma/generated/models/get_sync_output.rb +207 -0
  98. data/lib/appnigma/generated/models/go_live_logic_input.rb +316 -0
  99. data/lib/appnigma/generated/models/go_live_logic_output.rb +281 -0
  100. data/lib/appnigma/generated/models/json_value.rb +1 -1
  101. data/lib/appnigma/generated/models/list_actions_output.rb +1 -1
  102. data/lib/appnigma/generated/models/list_connections_output.rb +3 -3
  103. data/lib/appnigma/generated/models/list_events_input.rb +302 -0
  104. data/lib/appnigma/generated/models/list_events_output.rb +193 -0
  105. data/lib/appnigma/generated/models/list_features_output.rb +179 -0
  106. data/lib/appnigma/generated/models/list_features_output_features_inner.rb +229 -0
  107. data/lib/appnigma/generated/models/list_functions_output.rb +1 -1
  108. data/lib/appnigma/generated/models/list_logic_input.rb +162 -0
  109. data/lib/appnigma/generated/models/list_logic_output.rb +209 -0
  110. data/lib/appnigma/generated/models/list_logic_runs_input.rb +275 -0
  111. data/lib/appnigma/generated/models/list_logic_runs_output.rb +193 -0
  112. data/lib/appnigma/generated/models/list_platforms_output.rb +1 -1
  113. data/lib/appnigma/generated/models/list_record_changes_input.rb +375 -0
  114. data/lib/appnigma/generated/models/list_record_changes_output.rb +193 -0
  115. data/lib/appnigma/generated/models/list_webhooks_output.rb +180 -0
  116. data/lib/appnigma/generated/models/logic_check_problem.rb +203 -0
  117. data/lib/appnigma/generated/models/logic_conditional.rb +3 -3
  118. data/lib/appnigma/generated/models/logic_draft.rb +257 -0
  119. data/lib/appnigma/generated/models/logic_entry.rb +441 -0
  120. data/lib/appnigma/generated/models/logic_entry_failure.rb +205 -0
  121. data/lib/appnigma/generated/models/logic_folder_problem.rb +218 -0
  122. data/lib/appnigma/generated/models/logic_run.rb +483 -0
  123. data/lib/appnigma/generated/models/logic_test_call.rb +269 -0
  124. data/lib/appnigma/generated/models/platform_entry.rb +63 -6
  125. data/lib/appnigma/generated/models/platform_entry_coverage_inner.rb +1 -1
  126. data/lib/appnigma/generated/models/platform_request_input.rb +1 -1
  127. data/lib/appnigma/generated/models/platform_request_input_body.rb +1 -1
  128. data/lib/appnigma/generated/models/platform_request_output.rb +1 -1
  129. data/lib/appnigma/generated/models/ran_as.rb +1 -1
  130. data/lib/appnigma/generated/models/record_change.rb +231 -0
  131. data/lib/appnigma/generated/models/record_change_record.rb +105 -0
  132. data/lib/appnigma/generated/models/run_action_input.rb +1 -1
  133. data/lib/appnigma/generated/models/run_action_output.rb +1 -1
  134. data/lib/appnigma/generated/models/run_input.rb +1 -1
  135. data/lib/appnigma/generated/models/run_output.rb +1 -1
  136. data/lib/appnigma/generated/models/sdk_error.rb +1 -1
  137. data/lib/appnigma/generated/models/sdk_error_error.rb +3 -3
  138. data/lib/appnigma/generated/models/sdk_error_error_details.rb +81 -6
  139. data/lib/appnigma/generated/models/sdk_problem.rb +1 -1
  140. data/lib/appnigma/generated/models/set_alerts_input.rb +197 -0
  141. data/lib/appnigma/generated/models/set_alerts_output.rb +180 -0
  142. data/lib/appnigma/generated/models/set_sync_input.rb +177 -0
  143. data/lib/appnigma/generated/models/set_sync_output.rb +207 -0
  144. data/lib/appnigma/generated/models/switch_logic_off_input.rb +200 -0
  145. data/lib/appnigma/generated/models/switch_logic_off_output.rb +315 -0
  146. data/lib/appnigma/generated/models/switch_logic_on_input.rb +200 -0
  147. data/lib/appnigma/generated/models/switch_logic_on_output.rb +315 -0
  148. data/lib/appnigma/generated/models/sync_health.rb +231 -0
  149. data/lib/appnigma/generated/models/test_logic_input.rb +355 -0
  150. data/lib/appnigma/generated/models/test_logic_output.rb +418 -0
  151. data/lib/appnigma/generated/models/test_logic_output_error.rb +231 -0
  152. data/lib/appnigma/generated/models/update_logic_input.rb +359 -0
  153. data/lib/appnigma/generated/models/update_logic_output.rb +205 -0
  154. data/lib/appnigma/generated/version.rb +1 -1
  155. data/lib/appnigma/generated.rb +77 -1
  156. data/lib/appnigma/logic.rb +176 -0
  157. data/lib/appnigma/names.rb +4 -4
  158. data/lib/appnigma/platforms.rb +11 -1
  159. data/lib/appnigma/portal.rb +8 -5
  160. data/lib/appnigma/records.rb +46 -0
  161. data/lib/appnigma/schema_type.rb +149 -0
  162. data/lib/appnigma/sync.rb +30 -0
  163. data/lib/appnigma/types_printer.rb +154 -0
  164. data/lib/appnigma/verify_webhook.rb +107 -0
  165. data/lib/appnigma/version.rb +2 -2
  166. data/lib/appnigma/webhooks.rb +79 -0
  167. data/lib/appnigma.rb +1 -0
  168. metadata +95 -3
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The routes a customer's product calls through an Appnigma SDK. Every answer carries a request id in X-Request-Id; quote it when you write to support.
5
5
 
6
- The version of the OpenAPI document: 4.0.0
6
+ The version of the OpenAPI document: 5.4.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.26.0
@@ -19,11 +19,27 @@ require 'appnigma/generated/configuration'
19
19
 
20
20
  # Models
21
21
  require 'appnigma/generated/models/action_entry'
22
+ require 'appnigma/generated/models/check_logic_input'
23
+ require 'appnigma/generated/models/check_logic_output'
24
+ require 'appnigma/generated/models/client_event'
25
+ require 'appnigma/generated/models/client_event_delivery'
26
+ require 'appnigma/generated/models/client_event_type'
27
+ require 'appnigma/generated/models/client_webhook'
28
+ require 'appnigma/generated/models/connect_end_customer_input'
29
+ require 'appnigma/generated/models/connect_end_customer_output'
30
+ require 'appnigma/generated/models/connect_field'
22
31
  require 'appnigma/generated/models/connection_status'
23
32
  require 'appnigma/generated/models/create_connection_link_input'
24
33
  require 'appnigma/generated/models/create_connection_link_output'
34
+ require 'appnigma/generated/models/create_logic_input'
35
+ require 'appnigma/generated/models/create_logic_input_trigger'
36
+ require 'appnigma/generated/models/create_logic_input_trigger_any_of'
37
+ require 'appnigma/generated/models/create_logic_input_trigger_any_of1'
38
+ require 'appnigma/generated/models/create_logic_output'
25
39
  require 'appnigma/generated/models/create_portal_link_input'
26
40
  require 'appnigma/generated/models/create_portal_link_output'
41
+ require 'appnigma/generated/models/create_webhook_input'
42
+ require 'appnigma/generated/models/create_webhook_output'
27
43
  require 'appnigma/generated/models/crm_company'
28
44
  require 'appnigma/generated/models/crm_company_get_output'
29
45
  require 'appnigma/generated/models/crm_company_list_output'
@@ -45,27 +61,73 @@ require 'appnigma/generated/models/crm_labelled'
45
61
  require 'appnigma/generated/models/crm_list_input'
46
62
  require 'appnigma/generated/models/crm_phone'
47
63
  require 'appnigma/generated/models/crm_update_input'
64
+ require 'appnigma/generated/models/delete_end_customer_input'
65
+ require 'appnigma/generated/models/delete_end_customer_output'
66
+ require 'appnigma/generated/models/delete_end_customer_output_connections_inner'
67
+ require 'appnigma/generated/models/delete_end_customer_output_logic_folder'
68
+ require 'appnigma/generated/models/delete_end_customer_output_steps_inner'
69
+ require 'appnigma/generated/models/delete_webhook_input'
70
+ require 'appnigma/generated/models/delete_webhook_output'
71
+ require 'appnigma/generated/models/discard_logic_input'
72
+ require 'appnigma/generated/models/discard_logic_output'
73
+ require 'appnigma/generated/models/disconnect_connection_input'
74
+ require 'appnigma/generated/models/disconnect_connection_output'
75
+ require 'appnigma/generated/models/edit_logic_input'
76
+ require 'appnigma/generated/models/edit_logic_output'
77
+ require 'appnigma/generated/models/encrypted_fields'
48
78
  require 'appnigma/generated/models/end_customer'
49
79
  require 'appnigma/generated/models/end_customer_connection'
50
80
  require 'appnigma/generated/models/function_entry'
51
81
  require 'appnigma/generated/models/function_owner'
52
82
  require 'appnigma/generated/models/function_owner_one_of'
53
83
  require 'appnigma/generated/models/function_owner_one_of1'
84
+ require 'appnigma/generated/models/get_alerts_output'
85
+ require 'appnigma/generated/models/get_connect_key_output'
54
86
  require 'appnigma/generated/models/get_connection_input'
55
87
  require 'appnigma/generated/models/get_connection_output'
56
88
  require 'appnigma/generated/models/get_guide_output'
89
+ require 'appnigma/generated/models/get_logic_go_live_status_input'
90
+ require 'appnigma/generated/models/get_logic_go_live_status_output'
91
+ require 'appnigma/generated/models/get_logic_input'
92
+ require 'appnigma/generated/models/get_logic_output'
93
+ require 'appnigma/generated/models/get_logic_output_file'
94
+ require 'appnigma/generated/models/get_platform_input'
95
+ require 'appnigma/generated/models/get_platform_output'
96
+ require 'appnigma/generated/models/get_sync_output'
97
+ require 'appnigma/generated/models/go_live_logic_input'
98
+ require 'appnigma/generated/models/go_live_logic_output'
57
99
  require 'appnigma/generated/models/json_value'
58
100
  require 'appnigma/generated/models/list_actions_output'
59
101
  require 'appnigma/generated/models/list_connections_output'
102
+ require 'appnigma/generated/models/list_events_input'
103
+ require 'appnigma/generated/models/list_events_output'
104
+ require 'appnigma/generated/models/list_features_output'
105
+ require 'appnigma/generated/models/list_features_output_features_inner'
60
106
  require 'appnigma/generated/models/list_functions_output'
107
+ require 'appnigma/generated/models/list_logic_input'
108
+ require 'appnigma/generated/models/list_logic_output'
109
+ require 'appnigma/generated/models/list_logic_runs_input'
110
+ require 'appnigma/generated/models/list_logic_runs_output'
61
111
  require 'appnigma/generated/models/list_platforms_output'
112
+ require 'appnigma/generated/models/list_record_changes_input'
113
+ require 'appnigma/generated/models/list_record_changes_output'
114
+ require 'appnigma/generated/models/list_webhooks_output'
115
+ require 'appnigma/generated/models/logic_check_problem'
62
116
  require 'appnigma/generated/models/logic_conditional'
117
+ require 'appnigma/generated/models/logic_draft'
118
+ require 'appnigma/generated/models/logic_entry'
119
+ require 'appnigma/generated/models/logic_entry_failure'
120
+ require 'appnigma/generated/models/logic_folder_problem'
121
+ require 'appnigma/generated/models/logic_run'
122
+ require 'appnigma/generated/models/logic_test_call'
63
123
  require 'appnigma/generated/models/platform_entry'
64
124
  require 'appnigma/generated/models/platform_entry_coverage_inner'
65
125
  require 'appnigma/generated/models/platform_request_input'
66
126
  require 'appnigma/generated/models/platform_request_input_body'
67
127
  require 'appnigma/generated/models/platform_request_output'
68
128
  require 'appnigma/generated/models/ran_as'
129
+ require 'appnigma/generated/models/record_change'
130
+ require 'appnigma/generated/models/record_change_record'
69
131
  require 'appnigma/generated/models/run_action_input'
70
132
  require 'appnigma/generated/models/run_action_output'
71
133
  require 'appnigma/generated/models/run_input'
@@ -74,6 +136,20 @@ require 'appnigma/generated/models/sdk_error'
74
136
  require 'appnigma/generated/models/sdk_error_error'
75
137
  require 'appnigma/generated/models/sdk_error_error_details'
76
138
  require 'appnigma/generated/models/sdk_problem'
139
+ require 'appnigma/generated/models/set_alerts_input'
140
+ require 'appnigma/generated/models/set_alerts_output'
141
+ require 'appnigma/generated/models/set_sync_input'
142
+ require 'appnigma/generated/models/set_sync_output'
143
+ require 'appnigma/generated/models/switch_logic_off_input'
144
+ require 'appnigma/generated/models/switch_logic_off_output'
145
+ require 'appnigma/generated/models/switch_logic_on_input'
146
+ require 'appnigma/generated/models/switch_logic_on_output'
147
+ require 'appnigma/generated/models/sync_health'
148
+ require 'appnigma/generated/models/test_logic_input'
149
+ require 'appnigma/generated/models/test_logic_output'
150
+ require 'appnigma/generated/models/test_logic_output_error'
151
+ require 'appnigma/generated/models/update_logic_input'
152
+ require 'appnigma/generated/models/update_logic_output'
77
153
 
78
154
  # APIs
79
155
  require 'appnigma/generated/api/default_api'
@@ -0,0 +1,176 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "checks"
4
+ require_relative "names"
5
+
6
+ module Appnigma
7
+ # Your logic and each end customer's, for a logic screen in your own
8
+ # product: `client.logic.list`, `get`, `create`, `update`, `discard` and
9
+ # `check` (24.5), and `go_live`, `go_live_status`, `switch_off`,
10
+ # `switch_on` and `runs` (24.6), and `edit` and `test` (24.7). Without
11
+ # `end_customer_id:`, or with nil, a call is about your own logic; with an
12
+ # id, that end customer's. Changes are drafts kept on our side: nothing
13
+ # reaches your repo until `go_live`. The reads and the switches are retried;
14
+ # a create, save, discard, check, go-live, edit or test is made once, since
15
+ # a repeat after a lost answer would clash with its own first attempt,
16
+ # change the draft twice, or take a second test machine.
17
+ class Logic
18
+ # `list`'s default: every owner's logic, yours and each end customer's.
19
+ # nil is your own alone, so it cannot be the default.
20
+ EVERYONE = Object.new.tap { |everyone| everyone.define_singleton_method(:inspect) { "EVERYONE" } }.freeze
21
+
22
+ def initialize(client)
23
+ @client = client
24
+ end
25
+
26
+ # Your logic and every end customer's, each with whose it is (`owner`,
27
+ # `end_customer_id`), whether it is `on`, and its `status`: live, failed,
28
+ # draft or checking. An id lists that end customer's; nil your own.
29
+ # `folder_problems` names each end customer whose whole folder their last
30
+ # go-live kept at the version before, and why.
31
+ def list(end_customer_id: EVERYONE, timeout_ms: nil)
32
+ body = {}
33
+ unless end_customer_id.equal?(EVERYONE)
34
+ Checks.end_customer_id!(end_customer_id) unless end_customer_id.nil?
35
+ body["endCustomerId"] = end_customer_id
36
+ end
37
+ @client.call(:list_logic, body, timeout_ms: timeout_ms)
38
+ end
39
+
40
+ # One logic: its `file` on main, the `draft` we keep of it, and its
41
+ # `entry` as `list` has it.
42
+ def get(platform:, name:, end_customer_id: nil, timeout_ms: nil)
43
+ @client.call(:get_logic, logic_ref(end_customer_id, platform, name), timeout_ms: timeout_ms)
44
+ end
45
+
46
+ # A new logic from our template, kept as a draft until it goes live.
47
+ # `trigger` is a read or a write of a crm object, `{ object: "deal",
48
+ # operation: "write", timing: "before" }`, or an action, `{ action:
49
+ # "get-call-transcript", timing: "after" }`. Made once.
50
+ def create(platform:, name:, trigger:, end_customer_id: nil, timeout_ms: nil)
51
+ body = logic_ref(end_customer_id, platform, name).merge("trigger" => trigger)
52
+ one_attempt(:create_logic, body, timeout_ms)
53
+ end
54
+
55
+ # Saves the whole file as the draft, only on the revision it was made on:
56
+ # the draft's, or 0 for the first change to a file on main, with that
57
+ # file's sha as `base_sha`. A save on an older revision raises
58
+ # NotAvailableError with DRAFT_CHANGED and the draft now as its `draft`.
59
+ # Made once.
60
+ def update(platform:, name:, source:, revision:, base_sha: nil, end_customer_id: nil, timeout_ms: nil)
61
+ body = logic_ref(end_customer_id, platform, name)
62
+ .merge(Names.camel_keys(source: source, revision: revision, base_sha: base_sha))
63
+ one_attempt(:update_logic, body, timeout_ms)
64
+ end
65
+
66
+ # Throws the draft away, only on the revision you last had: a file on
67
+ # main goes back to what main holds, and a new logic is gone. Made once.
68
+ def discard(platform:, name:, revision:, end_customer_id: nil, timeout_ms: nil)
69
+ one_attempt(:discard_logic, logic_ref(end_customer_id, platform, name).merge("revision" => revision), timeout_ms)
70
+ end
71
+
72
+ # The check going live runs first, with `problems` by line and column.
73
+ # Without `source`, the saved draft is checked, or the file on main. Made
74
+ # once.
75
+ def check(platform:, name:, source: nil, end_customer_id: nil, timeout_ms: nil)
76
+ body = logic_ref(end_customer_id, platform, name).merge(Names.camel_keys(source: source))
77
+ one_attempt(:check_logic, body, timeout_ms)
78
+ end
79
+
80
+ # Checks the draft at the revision you last had, commits it to your repo's
81
+ # main branch, and starts the go-live a push gets. Answers once committed,
82
+ # with `state` "checking" and the `commit_sha`; follow it with
83
+ # `go_live_status`. A file changed on main since the draft began raises
84
+ # NotAvailableError with FILE_CHANGED unless `replace_latest:`; settings an
85
+ # end customer has not set raise SETTINGS_MISSING unless
86
+ # `ignore_missing_settings:`. Made once.
87
+ def go_live(platform:, name:, revision:, replace_latest: nil, ignore_missing_settings: nil, end_customer_id: nil,
88
+ timeout_ms: nil)
89
+ flags = Names.camel_keys(revision: revision, replace_latest: replace_latest,
90
+ ignore_missing_settings: ignore_missing_settings)
91
+ one_attempt(:go_live_logic, logic_ref(end_customer_id, platform, name).merge(flags), timeout_ms)
92
+ end
93
+
94
+ # Where the logic's go-live stands: `state` checking, live with the
95
+ # `version` and `logic_id` live now, failed with `reason` and
96
+ # `still_live`, or none. The first read that sees it live settles it, so a
97
+ # later read answers none, with the version live now to compare.
98
+ def go_live_status(platform:, name:, end_customer_id: nil, timeout_ms: nil)
99
+ @client.call(:get_logic_go_live_status, logic_ref(end_customer_id, platform, name), timeout_ms: timeout_ms)
100
+ end
101
+
102
+ # Stops an always-on logic, named by the `logic_id` `list` gives it, for
103
+ # one end customer or, without one, for everyone, from the next call on.
104
+ # Nothing is pushed. Already off answers `changed` false.
105
+ def switch_off(logic_id:, end_customer_id: nil, timeout_ms: nil)
106
+ @client.call(:switch_logic_off, switch(logic_id, end_customer_id), timeout_ms: timeout_ms)
107
+ end
108
+
109
+ # Takes a switch `switch_off` made away. Everyone's switch and an end
110
+ # customer's are separate: one end customer's switched on while
111
+ # everyone's is off answers `runs` false with `reason`
112
+ # "switched_off_for_everyone".
113
+ def switch_on(logic_id:, end_customer_id: nil, timeout_ms: nil)
114
+ @client.call(:switch_logic_on, switch(logic_id, end_customer_id), timeout_ms: timeout_ms)
115
+ end
116
+
117
+ # What an always-on logic did on each call, newest first: ids and codes
118
+ # only, never the call's data or a message. Pass `next_cursor` back as
119
+ # `cursor:` for the next page; it is nil on the last.
120
+ def runs(logic_id:, end_customer_id: nil, limit: nil, cursor: nil, timeout_ms: nil)
121
+ Checks.end_customer_id!(end_customer_id) unless end_customer_id.nil?
122
+ body = Names.camel_keys(logic_id: logic_id, end_customer_id: end_customer_id, limit: limit, cursor: cursor)
123
+ @client.call(:list_logic_runs, body, timeout_ms: timeout_ms)
124
+ end
125
+
126
+ # Writes the change `prompt:` asks for in plain words, from the draft or
127
+ # the file on main, and saves it as the draft only when it passes the
128
+ # check; it never goes live. `saved` false means nothing was saved:
129
+ # `problems` point into `rejected_source`. `revision:` changes only the
130
+ # draft you last had; `requested_by:` is kept on the call's record. Made
131
+ # once, with three minutes to answer unless `timeout_ms:` says.
132
+ def edit(platform:, name:, prompt:, revision: nil, requested_by: nil, end_customer_id: nil, timeout_ms: nil)
133
+ body = logic_ref(end_customer_id, platform, name)
134
+ .merge(Names.camel_keys(prompt: prompt, revision: revision, requested_by: requested_by))
135
+ one_attempt(:edit_logic, body, slow(timeout_ms))
136
+ end
137
+
138
+ # Runs `source:`, else the draft, else the file on main (`ran_on`), once
139
+ # on `input:` in a sandbox with no internet, seeing only `settings:`.
140
+ # Every call it makes is listed in `calls` and answered empty. Answers its
141
+ # `output` or its `error`; `ran` false with `problems` when the file
142
+ # failed the check, `finished` false with `logs` when it gave no answer.
143
+ # Made once, with three minutes to answer unless `timeout_ms:` says.
144
+ def test(platform:, name:, input:, source: nil, settings: nil, requested_by: nil, end_customer_id: nil,
145
+ timeout_ms: nil)
146
+ body = logic_ref(end_customer_id, platform, name)
147
+ .merge(Names.camel_keys(source: source, input: input, settings: settings, requested_by: requested_by))
148
+ one_attempt(:test_logic, body, slow(timeout_ms))
149
+ end
150
+
151
+ private
152
+
153
+ def slow(timeout_ms)
154
+ timeout_ms || [@client.timeout_ms, LOGIC_SLOW_CALL_TIMEOUT_MS].max
155
+ end
156
+
157
+ def one_attempt(operation, body, timeout_ms)
158
+ @client.call(operation, body, policy: @client.one_attempt, timeout_ms: timeout_ms)
159
+ end
160
+
161
+ # Whose logic and which one. An id is checked by the server's own rule
162
+ # first; nil is left out, which the server reads as your own.
163
+ def logic_ref(end_customer_id, platform, name)
164
+ Checks.end_customer_id!(end_customer_id) unless end_customer_id.nil?
165
+ Checks.platform!(platform)
166
+ Names.camel_keys(end_customer_id: end_customer_id, platform: platform, name: name)
167
+ end
168
+
169
+ # A switch: the logic by its id, and the end customer it is for, left out
170
+ # for everyone.
171
+ def switch(logic_id, end_customer_id)
172
+ Checks.end_customer_id!(end_customer_id) unless end_customer_id.nil?
173
+ Names.camel_keys(logic_id: logic_id, end_customer_id: end_customer_id)
174
+ end
175
+ end
176
+ end
@@ -27,10 +27,10 @@ module Appnigma
27
27
  end
28
28
 
29
29
  # Wire keys whose value is someone else's content, passed through as it
30
- # came: a record's properties, a function's output and its schemas, a
31
- # platform's headers and body, a CRM record's raw form, a custom field's
32
- # value.
33
- FREE_FORM = %w[properties output inputSchema outputSchema headers body raw value].freeze
30
+ # came: a record's properties, a function's output and its schemas, an
31
+ # action's input and output schemas, a platform's headers and body, a CRM
32
+ # record's raw form, a custom field's value.
33
+ FREE_FORM = %w[properties input output inputSchema outputSchema headers body raw value].freeze
34
34
 
35
35
  # Wire keys whose value is a map keyed by someone else's names: the keys
36
36
  # are kept, the values converted.
@@ -2,7 +2,8 @@
2
2
 
3
3
  module Appnigma
4
4
  # The platforms switched on for you, and what each one covers:
5
- # `client.platforms.list`. A read, so it is retried.
5
+ # `client.platforms.list`, and one of them, `client.platforms.get` (24.2).
6
+ # Reads, so they are retried.
6
7
  class Platforms
7
8
  def initialize(client)
8
9
  @client = client
@@ -11,8 +12,17 @@ module Appnigma
11
12
  # Each platform with its `support`: `supported` when an adapter reads
12
13
  # and writes it in the shared shapes, with `coverage` naming each object
13
14
  # and its actions, or `experimental` when only `request` reaches it.
15
+ # `logo_url` is the platform's logo, ready for an image's `src`, or nil.
14
16
  def list(timeout_ms: nil)
15
17
  @client.call(:list_platforms, timeout_ms: timeout_ms)
16
18
  end
19
+
20
+ # One platform switched on for you, answered as one `list` entry. The
21
+ # platform travels in the body; one the server will refuse still reaches
22
+ # the server's refusal.
23
+ def get(platform:, timeout_ms: nil)
24
+ Checks.platform!(platform)
25
+ @client.call(:get_platform, Names.camel_keys(platform: platform), timeout_ms: timeout_ms)
26
+ end
17
27
  end
18
28
  end
@@ -4,16 +4,19 @@ require_relative "names"
4
4
 
5
5
  module Appnigma
6
6
  # The custom logic portal, where one end customer sees and edits their own
7
- # logic: `client.portal.create_link` (22.1).
7
+ # logic, or you see yours and your end customers:
8
+ # `client.portal.create_link` (22.1, 24.8).
8
9
  class Portal
9
10
  def initialize(client)
10
11
  @client = client
11
12
  end
12
13
 
13
- # A link that opens the portal for one end customer. Show it in an iframe
14
- # on one of your sites, or open it in a new tab. It works once and expires
15
- # after 15 minutes. Made once, never retried: every call makes a new link.
16
- def create_link(end_customer_id:, timeout_ms: nil)
14
+ # A link that opens the portal for one end customer, or with no
15
+ # end_customer_id (or nil) for you: your own logic, and your end customers
16
+ # to open one at a time. Show it in an iframe on one of your sites, or open
17
+ # it in a new tab. It works once and expires after 15 minutes. Made once,
18
+ # never retried: every call makes a new link.
19
+ def create_link(end_customer_id: nil, timeout_ms: nil)
17
20
  body = Names.camel_keys(end_customer_id: end_customer_id)
18
21
  @client.call(:create_portal_link, body, policy: @client.one_attempt, timeout_ms: timeout_ms)
19
22
  end
@@ -0,0 +1,46 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "date"
4
+ require_relative "checks"
5
+ require_relative "constants"
6
+ require_relative "names"
7
+
8
+ module Appnigma
9
+ # The changes the sync notices, asked for: `client.records.changes` (24.13).
10
+ class Records
11
+ def initialize(client)
12
+ @client = client
13
+ end
14
+
15
+ # One page of one end customer's changes of one object since a time you
16
+ # keep, read live from the platform whether the sync is on or off. Each
17
+ # change is `record_id`, `updated_at` and `record`, as `crm.*` answers
18
+ # it; your own crm writes are left out. Pass `next_cursor` back as
19
+ # `cursor:` with the same `since:`. A platform that cannot list changes
20
+ # by time is an InputError naming `platform`; the feature off for your
21
+ # company is an AuthError with SYNC_NOT_ENABLED. A read, so it is retried.
22
+ def changes(end_customer_id:, platform:, object:, since:, limit: nil, cursor: nil, timeout_ms: nil)
23
+ Checks.end_customer_id!(end_customer_id)
24
+ Checks.platform!(platform)
25
+ Checks.refuse("object", "must be one of #{OBJECTS.join(", ")}") unless OBJECTS.include?(object)
26
+ unless zoned_time?(since)
27
+ Checks.refuse("since", "must be an ISO 8601 time with a time zone, such as 2026-11-11T09:00:00Z")
28
+ end
29
+ body = Names.camel_keys(end_customer_id: end_customer_id, platform: platform, object: object, since: since,
30
+ limit: limit, cursor: cursor)
31
+ @client.call(:list_record_changes, body, timeout_ms: timeout_ms)
32
+ end
33
+
34
+ private
35
+
36
+ # The server's own shape; DateTime then refuses a day that does not exist.
37
+ def zoned_time?(value)
38
+ return false unless value.is_a?(String) && value.match?(ZONED_TIME_PATTERN)
39
+
40
+ DateTime.iso8601(value)
41
+ true
42
+ rescue Date::Error
43
+ false
44
+ end
45
+ end
46
+ end
@@ -0,0 +1,149 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Appnigma
4
+ # One JSON Schema as an RBS type, for the file `appnigma types` writes
5
+ # (24.3). The schemas are JSON Schema as the runtime made them. This covers
6
+ # what those produce, as the TypeScript printer does: objects, strings,
7
+ # numbers, booleans, null, arrays and tuples, enums and literals, unions,
8
+ # intersections of objects, records, nullable, and `$ref` into `$defs`.
9
+ # Anything else is `untyped`, so the file always parses. Keys are strings,
10
+ # as the input is sent and the output comes back.
11
+ class SchemaType
12
+ INDENT = " "
13
+ DEFS_PREFIX = "#/$defs/"
14
+ SIMPLE = { "string" => "String", "integer" => "Integer", "number" => "Numeric", "boolean" => "bool",
15
+ "null" => "nil" }.freeze
16
+
17
+ # The schema as a type, its record fields indented one level inside a
18
+ # module.
19
+ def self.of(schema)
20
+ new(schema).print(schema, 1)
21
+ end
22
+
23
+ # A string literal RBS reads back exactly. Not `inspect`: RBS reads
24
+ # Ruby's `\#` as something else.
25
+ def self.quote(text)
26
+ escaped = text.to_s.gsub(/[\\"]/) { |character| "\\#{character}" }
27
+ "\"#{escaped.gsub(/[\x00-\x1f\x7f]/) { |character| format("\\u%04x", character.ord) }}\""
28
+ end
29
+
30
+ def initialize(root)
31
+ @root = root.is_a?(Hash) ? root : {}
32
+ @expanding = Set.new
33
+ end
34
+
35
+ def print(schema, depth)
36
+ return "untyped" unless schema.is_a?(Hash)
37
+
38
+ literal_or_reference(schema, depth) || choice(schema, depth) || by_type(schema, depth)
39
+ end
40
+
41
+ private
42
+
43
+ def literal_or_reference(schema, depth)
44
+ return reference(schema["$ref"], depth) if schema["$ref"].is_a?(String)
45
+ return union(schema["enum"].map { |value| literal(value) }) if schema["enum"].is_a?(Array)
46
+
47
+ literal(schema["const"]) if schema.key?("const")
48
+ end
49
+
50
+ def choice(schema, depth)
51
+ members = schema["anyOf"] || schema["oneOf"]
52
+ return union(members.map { |member| print(member, depth) }) if members.is_a?(Array)
53
+
54
+ intersection(schema["allOf"], depth) if schema["allOf"].is_a?(Array)
55
+ end
56
+
57
+ def by_type(schema, depth)
58
+ kind = schema["type"]
59
+ return union(kind.map { |one| print(schema.merge("type" => one), depth) }) if kind.is_a?(Array)
60
+ return SIMPLE[kind] if SIMPLE.key?(kind)
61
+ return array(schema, depth) if kind == "array"
62
+ return object(schema, depth) if kind == "object"
63
+
64
+ "untyped"
65
+ end
66
+
67
+ def reference(ref, depth)
68
+ name = ref.delete_prefix(DEFS_PREFIX)
69
+ definition = definition_for(ref)
70
+ return "untyped" if definition.nil? || @expanding.include?(name)
71
+
72
+ @expanding << name
73
+ print(definition, depth).tap { @expanding.delete(name) }
74
+ end
75
+
76
+ def definition_for(ref)
77
+ definitions = @root["$defs"]
78
+ return nil unless ref.start_with?(DEFS_PREFIX) && definitions.is_a?(Hash)
79
+
80
+ definitions[ref.delete_prefix(DEFS_PREFIX)]
81
+ end
82
+
83
+ def resolved(schema)
84
+ schema.is_a?(Hash) && schema["$ref"].is_a?(String) ? definition_for(schema["$ref"]) : schema
85
+ end
86
+
87
+ def literal(value)
88
+ case value
89
+ when String then self.class.quote(value)
90
+ when Integer, true, false then value.to_s
91
+ when nil then "nil"
92
+ when Float then "Float"
93
+ else "untyped"
94
+ end
95
+ end
96
+
97
+ def union(types)
98
+ unique = types.uniq
99
+ unique.include?("untyped") ? "untyped" : unique.join(" | ")
100
+ end
101
+
102
+ # RBS has no intersection of records that reads well: objects are merged
103
+ # into one, anything else is untyped.
104
+ def intersection(members, depth)
105
+ objects = members.map { |member| resolved(member) }
106
+ return "untyped" unless objects.all? { |member| member.is_a?(Hash) && member["properties"].is_a?(Hash) }
107
+
108
+ object({ "type" => "object", "properties" => objects.map { |member| member["properties"] }.reduce(:merge),
109
+ "required" => objects.flat_map { |member| Array(member["required"]) } }, depth)
110
+ end
111
+
112
+ def array(schema, depth)
113
+ return tuple(schema, depth) if schema["prefixItems"].is_a?(Array)
114
+ return "Array[untyped]" unless schema.key?("items")
115
+
116
+ "Array[#{print(schema["items"], depth)}]"
117
+ end
118
+
119
+ # A fixed list is a tuple, which RBS types as an array; one with more
120
+ # items after it is an array of every member's type.
121
+ def tuple(schema, depth)
122
+ members = schema["prefixItems"].map { |item| print(item, depth) }
123
+ return "[#{members.join(", ")}]" unless schema["items"].is_a?(Hash)
124
+
125
+ "Array[#{union(members + [print(schema["items"], depth)])}]"
126
+ end
127
+
128
+ def object(schema, depth)
129
+ properties = schema["properties"]
130
+ return map_of(schema["additionalProperties"], depth) unless properties.is_a?(Hash) && !properties.empty?
131
+
132
+ record(properties, Array(schema["required"]), depth)
133
+ end
134
+
135
+ def map_of(extra, depth)
136
+ return "Hash[String, #{print(extra, depth)}]" if extra.is_a?(Hash)
137
+
138
+ "Hash[String, #{extra == false ? "bot" : "untyped"}]"
139
+ end
140
+
141
+ def record(properties, required, depth)
142
+ pad = INDENT * (depth + 1)
143
+ fields = properties.map do |key, shape|
144
+ "#{pad}#{"?" unless required.include?(key)}#{self.class.quote(key)} => #{print(shape, depth + 1)}"
145
+ end
146
+ "{\n#{fields.join(",\n")}\n#{INDENT * depth}}"
147
+ end
148
+ end
149
+ end
@@ -0,0 +1,30 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "checks"
4
+
5
+ module Appnigma
6
+ # Whether changes in your end customers' accounts are noticed:
7
+ # `client.sync.get` and `set` (24.12). Both are retried: setting a switch
8
+ # twice leaves it where it was set.
9
+ class Sync
10
+ def initialize(client)
11
+ @client = client
12
+ end
13
+
14
+ # Whether it is on, and the `platforms` it reads: those whose API can
15
+ # list records changed since a time.
16
+ def get(timeout_ms: nil)
17
+ @client.call(:get_sync, timeout_ms: timeout_ms)
18
+ end
19
+
20
+ # On: every 5 minutes, each connected HubSpot and Pipedrive account is
21
+ # asked for the contacts, companies and deals changed since the last
22
+ # read; records your own crm writes changed are left out. Off stops the
23
+ # reading. Switching on while the feature is off for your company is an
24
+ # AuthError with SYNC_NOT_ENABLED; switching off is never refused.
25
+ def set(on:, timeout_ms: nil)
26
+ Checks.refuse("on", "must be true or false") unless [true, false].include?(on)
27
+ @client.call(:set_sync, { "on" => on }, timeout_ms: timeout_ms)
28
+ end
29
+ end
30
+ end