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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +14 -0
- data/README.md +592 -26
- data/exe/appnigma +8 -0
- data/lib/appnigma/actions.rb +33 -0
- data/lib/appnigma/checks.rb +13 -0
- data/lib/appnigma/client.rb +30 -13
- data/lib/appnigma/command.rb +154 -0
- data/lib/appnigma/command_files.rb +46 -0
- data/lib/appnigma/connect_fields.rb +83 -0
- data/lib/appnigma/connections.rb +72 -3
- data/lib/appnigma/constants.rb +57 -0
- data/lib/appnigma/end_customers.rb +29 -0
- data/lib/appnigma/errors.rb +44 -6
- data/lib/appnigma/features.rb +19 -0
- data/lib/appnigma/files.rb +26 -0
- data/lib/appnigma/generated/api/default_api.rb +2149 -380
- data/lib/appnigma/generated/api_client.rb +1 -1
- data/lib/appnigma/generated/api_error.rb +1 -1
- data/lib/appnigma/generated/api_model_base.rb +1 -1
- data/lib/appnigma/generated/configuration.rb +1 -1
- data/lib/appnigma/generated/models/action_entry.rb +1 -1
- data/lib/appnigma/generated/models/check_logic_input.rb +276 -0
- data/lib/appnigma/generated/models/check_logic_output.rb +193 -0
- data/lib/appnigma/generated/models/client_event.rb +309 -0
- data/lib/appnigma/generated/models/client_event_delivery.rb +306 -0
- data/lib/appnigma/generated/models/client_event_type.rb +44 -0
- data/lib/appnigma/generated/models/client_webhook.rb +346 -0
- data/lib/appnigma/generated/models/connect_end_customer_input.rb +243 -0
- data/lib/appnigma/generated/models/connect_end_customer_output.rb +294 -0
- data/lib/appnigma/generated/models/connect_field.rb +308 -0
- data/lib/appnigma/generated/models/connection_status.rb +1 -1
- data/lib/appnigma/generated/models/create_connection_link_input.rb +1 -1
- data/lib/appnigma/generated/models/create_connection_link_output.rb +1 -1
- data/lib/appnigma/generated/models/create_logic_input.rb +273 -0
- data/lib/appnigma/generated/models/create_logic_input_trigger.rb +104 -0
- data/lib/appnigma/generated/models/create_logic_input_trigger_any_of.rb +257 -0
- data/lib/appnigma/generated/models/create_logic_input_trigger_any_of1.rb +238 -0
- data/lib/appnigma/generated/models/create_logic_output.rb +230 -0
- data/lib/appnigma/generated/models/create_portal_link_input.rb +2 -18
- data/lib/appnigma/generated/models/create_portal_link_output.rb +1 -1
- data/lib/appnigma/generated/models/create_webhook_input.rb +187 -0
- data/lib/appnigma/generated/models/create_webhook_output.rb +204 -0
- data/lib/appnigma/generated/models/crm_company.rb +1 -1
- data/lib/appnigma/generated/models/crm_company_get_output.rb +1 -1
- data/lib/appnigma/generated/models/crm_company_list_output.rb +1 -1
- data/lib/appnigma/generated/models/crm_company_write_output.rb +1 -1
- data/lib/appnigma/generated/models/crm_contact.rb +1 -1
- data/lib/appnigma/generated/models/crm_contact_get_output.rb +1 -1
- data/lib/appnigma/generated/models/crm_contact_list_output.rb +1 -1
- data/lib/appnigma/generated/models/crm_contact_write_output.rb +1 -1
- data/lib/appnigma/generated/models/crm_create_input.rb +1 -1
- data/lib/appnigma/generated/models/crm_custom_field.rb +1 -1
- data/lib/appnigma/generated/models/crm_deal.rb +1 -1
- data/lib/appnigma/generated/models/crm_deal_create_input.rb +1 -1
- data/lib/appnigma/generated/models/crm_deal_get_output.rb +1 -1
- data/lib/appnigma/generated/models/crm_deal_list_output.rb +1 -1
- data/lib/appnigma/generated/models/crm_deal_write_output.rb +1 -1
- data/lib/appnigma/generated/models/crm_email.rb +1 -1
- data/lib/appnigma/generated/models/crm_get_input.rb +1 -1
- data/lib/appnigma/generated/models/crm_labelled.rb +1 -1
- data/lib/appnigma/generated/models/crm_list_input.rb +1 -1
- data/lib/appnigma/generated/models/crm_phone.rb +1 -1
- data/lib/appnigma/generated/models/crm_update_input.rb +1 -1
- data/lib/appnigma/generated/models/delete_end_customer_input.rb +178 -0
- data/lib/appnigma/generated/models/delete_end_customer_output.rb +286 -0
- data/lib/appnigma/generated/models/delete_end_customer_output_connections_inner.rb +238 -0
- data/lib/appnigma/generated/models/delete_end_customer_output_logic_folder.rb +255 -0
- data/lib/appnigma/generated/models/delete_end_customer_output_steps_inner.rb +257 -0
- data/lib/appnigma/generated/models/delete_webhook_input.rb +189 -0
- data/lib/appnigma/generated/models/delete_webhook_output.rb +228 -0
- data/lib/appnigma/generated/models/discard_logic_input.rb +292 -0
- data/lib/appnigma/generated/models/discard_logic_output.rb +254 -0
- data/lib/appnigma/generated/models/disconnect_connection_input.rb +216 -0
- data/lib/appnigma/generated/models/disconnect_connection_output.rb +294 -0
- data/lib/appnigma/generated/models/edit_logic_input.rb +368 -0
- data/lib/appnigma/generated/models/edit_logic_output.rb +298 -0
- data/lib/appnigma/generated/models/encrypted_fields.rb +357 -0
- data/lib/appnigma/generated/models/end_customer.rb +17 -3
- data/lib/appnigma/generated/models/end_customer_connection.rb +1 -1
- data/lib/appnigma/generated/models/function_entry.rb +1 -1
- data/lib/appnigma/generated/models/function_owner.rb +1 -1
- data/lib/appnigma/generated/models/function_owner_one_of.rb +1 -1
- data/lib/appnigma/generated/models/function_owner_one_of1.rb +1 -1
- data/lib/appnigma/generated/models/get_alerts_output.rb +180 -0
- data/lib/appnigma/generated/models/get_connect_key_output.rb +256 -0
- data/lib/appnigma/generated/models/get_connection_input.rb +1 -1
- data/lib/appnigma/generated/models/get_connection_output.rb +34 -7
- data/lib/appnigma/generated/models/get_guide_output.rb +1 -1
- data/lib/appnigma/generated/models/get_logic_go_live_status_input.rb +247 -0
- data/lib/appnigma/generated/models/get_logic_go_live_status_output.rb +296 -0
- data/lib/appnigma/generated/models/get_logic_input.rb +247 -0
- data/lib/appnigma/generated/models/get_logic_output.rb +240 -0
- data/lib/appnigma/generated/models/get_logic_output_file.rb +204 -0
- data/lib/appnigma/generated/models/get_platform_input.rb +188 -0
- data/lib/appnigma/generated/models/get_platform_output.rb +326 -0
- data/lib/appnigma/generated/models/get_sync_output.rb +207 -0
- data/lib/appnigma/generated/models/go_live_logic_input.rb +316 -0
- data/lib/appnigma/generated/models/go_live_logic_output.rb +281 -0
- data/lib/appnigma/generated/models/json_value.rb +1 -1
- data/lib/appnigma/generated/models/list_actions_output.rb +1 -1
- data/lib/appnigma/generated/models/list_connections_output.rb +3 -3
- data/lib/appnigma/generated/models/list_events_input.rb +302 -0
- data/lib/appnigma/generated/models/list_events_output.rb +193 -0
- data/lib/appnigma/generated/models/list_features_output.rb +179 -0
- data/lib/appnigma/generated/models/list_features_output_features_inner.rb +229 -0
- data/lib/appnigma/generated/models/list_functions_output.rb +1 -1
- data/lib/appnigma/generated/models/list_logic_input.rb +162 -0
- data/lib/appnigma/generated/models/list_logic_output.rb +209 -0
- data/lib/appnigma/generated/models/list_logic_runs_input.rb +275 -0
- data/lib/appnigma/generated/models/list_logic_runs_output.rb +193 -0
- data/lib/appnigma/generated/models/list_platforms_output.rb +1 -1
- data/lib/appnigma/generated/models/list_record_changes_input.rb +375 -0
- data/lib/appnigma/generated/models/list_record_changes_output.rb +193 -0
- data/lib/appnigma/generated/models/list_webhooks_output.rb +180 -0
- data/lib/appnigma/generated/models/logic_check_problem.rb +203 -0
- data/lib/appnigma/generated/models/logic_conditional.rb +3 -3
- data/lib/appnigma/generated/models/logic_draft.rb +257 -0
- data/lib/appnigma/generated/models/logic_entry.rb +441 -0
- data/lib/appnigma/generated/models/logic_entry_failure.rb +205 -0
- data/lib/appnigma/generated/models/logic_folder_problem.rb +218 -0
- data/lib/appnigma/generated/models/logic_run.rb +483 -0
- data/lib/appnigma/generated/models/logic_test_call.rb +269 -0
- data/lib/appnigma/generated/models/platform_entry.rb +63 -6
- data/lib/appnigma/generated/models/platform_entry_coverage_inner.rb +1 -1
- data/lib/appnigma/generated/models/platform_request_input.rb +1 -1
- data/lib/appnigma/generated/models/platform_request_input_body.rb +1 -1
- data/lib/appnigma/generated/models/platform_request_output.rb +1 -1
- data/lib/appnigma/generated/models/ran_as.rb +1 -1
- data/lib/appnigma/generated/models/record_change.rb +231 -0
- data/lib/appnigma/generated/models/record_change_record.rb +105 -0
- data/lib/appnigma/generated/models/run_action_input.rb +1 -1
- data/lib/appnigma/generated/models/run_action_output.rb +1 -1
- data/lib/appnigma/generated/models/run_input.rb +1 -1
- data/lib/appnigma/generated/models/run_output.rb +1 -1
- data/lib/appnigma/generated/models/sdk_error.rb +1 -1
- data/lib/appnigma/generated/models/sdk_error_error.rb +3 -3
- data/lib/appnigma/generated/models/sdk_error_error_details.rb +81 -6
- data/lib/appnigma/generated/models/sdk_problem.rb +1 -1
- data/lib/appnigma/generated/models/set_alerts_input.rb +197 -0
- data/lib/appnigma/generated/models/set_alerts_output.rb +180 -0
- data/lib/appnigma/generated/models/set_sync_input.rb +177 -0
- data/lib/appnigma/generated/models/set_sync_output.rb +207 -0
- data/lib/appnigma/generated/models/switch_logic_off_input.rb +200 -0
- data/lib/appnigma/generated/models/switch_logic_off_output.rb +315 -0
- data/lib/appnigma/generated/models/switch_logic_on_input.rb +200 -0
- data/lib/appnigma/generated/models/switch_logic_on_output.rb +315 -0
- data/lib/appnigma/generated/models/sync_health.rb +231 -0
- data/lib/appnigma/generated/models/test_logic_input.rb +355 -0
- data/lib/appnigma/generated/models/test_logic_output.rb +418 -0
- data/lib/appnigma/generated/models/test_logic_output_error.rb +231 -0
- data/lib/appnigma/generated/models/update_logic_input.rb +359 -0
- data/lib/appnigma/generated/models/update_logic_output.rb +205 -0
- data/lib/appnigma/generated/version.rb +1 -1
- data/lib/appnigma/generated.rb +77 -1
- data/lib/appnigma/logic.rb +176 -0
- data/lib/appnigma/names.rb +4 -4
- data/lib/appnigma/platforms.rb +11 -1
- data/lib/appnigma/portal.rb +8 -5
- data/lib/appnigma/records.rb +46 -0
- data/lib/appnigma/schema_type.rb +149 -0
- data/lib/appnigma/sync.rb +30 -0
- data/lib/appnigma/types_printer.rb +154 -0
- data/lib/appnigma/verify_webhook.rb +107 -0
- data/lib/appnigma/version.rb +2 -2
- data/lib/appnigma/webhooks.rb +79 -0
- data/lib/appnigma.rb +1 -0
- metadata +95 -3
data/lib/appnigma/errors.rb
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
3
|
require_relative "constants"
|
|
4
|
+
require_relative "names"
|
|
4
5
|
|
|
5
6
|
module Appnigma
|
|
6
7
|
# Every failure this gem raises, whether the server answered with an error
|
|
@@ -20,7 +21,8 @@ module Appnigma
|
|
|
20
21
|
end
|
|
21
22
|
end
|
|
22
23
|
|
|
23
|
-
# 400
|
|
24
|
+
# 400, and 422 WEBHOOK_ADDRESS_REFUSED (24.11): an address the server will
|
|
25
|
+
# not send to, with `details["reason"]`. The server names each field it could not accept, as `problems`:
|
|
24
26
|
# a list of `{ field:, problem: }`. Also raised locally for a bad setting,
|
|
25
27
|
# a bad end customer id, or a `run` naming its function both by name and
|
|
26
28
|
# by id or neither, before any call.
|
|
@@ -46,13 +48,27 @@ module Appnigma
|
|
|
46
48
|
# 409 CONNECTION_NEEDS_RECONNECT: the end customer has to approve again.
|
|
47
49
|
class ReconnectError < Error; end
|
|
48
50
|
|
|
49
|
-
# Any other 409: the platform cannot give this yet
|
|
50
|
-
|
|
51
|
+
# Any other 409: the platform cannot give this yet, or a logic draft cannot
|
|
52
|
+
# be written (24.5), or put live or switched (24.6: NOTHING_TO_GO_LIVE,
|
|
53
|
+
# FILE_CHANGED, SETTINGS_MISSING with `details["names"]`,
|
|
54
|
+
# LOGIC_NOT_ALWAYS_ON). With DRAFT_CHANGED, `draft` is the draft now, in Ruby
|
|
55
|
+
# names, or nil when it was discarded; `details` keeps the wire's names.
|
|
56
|
+
class NotAvailableError < Error
|
|
57
|
+
attr_reader :draft
|
|
58
|
+
|
|
59
|
+
def initialize(**args)
|
|
60
|
+
super
|
|
61
|
+
draft = details["draft"]
|
|
62
|
+
@draft = draft.is_a?(Hash) ? Names.answer(draft) : nil
|
|
63
|
+
end
|
|
64
|
+
end
|
|
51
65
|
|
|
52
66
|
# 422 PLATFORM_REFUSED: the end customer's platform refused the call, and
|
|
53
67
|
# `message` is its reason. Never tried again: the same call would be
|
|
54
68
|
# refused the same way. `platform_status` is the status the platform
|
|
55
|
-
# answered, or nil.
|
|
69
|
+
# answered, or nil. 24.6: also 422 LOGIC_CHECK_FAILED, a draft
|
|
70
|
+
# `logic.go_live` sent that would not pass the checks, listed in
|
|
71
|
+
# `details["checkProblems"]`.
|
|
56
72
|
class PlatformRefusedError < Error
|
|
57
73
|
attr_reader :platform_status
|
|
58
74
|
|
|
@@ -79,6 +95,19 @@ module Appnigma
|
|
|
79
95
|
end
|
|
80
96
|
end
|
|
81
97
|
|
|
98
|
+
# Raised by `Appnigma.verify_webhook` (24.11), never by a call: the message
|
|
99
|
+
# your server received is not one we signed, or is too old. `reason` says
|
|
100
|
+
# which: missing_secret, body_not_raw, missing_header, malformed_header,
|
|
101
|
+
# too_old, mismatch or not_an_event. Answer it with a 400.
|
|
102
|
+
class WebhookSignatureError < Error
|
|
103
|
+
attr_reader :reason
|
|
104
|
+
|
|
105
|
+
def initialize(reason:, message:)
|
|
106
|
+
super(code: WEBHOOK_SIGNATURE_ERROR_CODE, message: message)
|
|
107
|
+
@reason = reason
|
|
108
|
+
end
|
|
109
|
+
end
|
|
110
|
+
|
|
82
111
|
# 429. `retry_after_seconds` is what the server's Retry-After header said,
|
|
83
112
|
# or nil when it sent none.
|
|
84
113
|
class RateLimitError < Error
|
|
@@ -135,14 +164,23 @@ module Appnigma
|
|
|
135
164
|
|
|
136
165
|
# Only CONNECTION_NEEDS_RECONNECT asks for a reconnect; any other 409 is
|
|
137
166
|
# something the platform cannot give yet. A 422 is the platform refusing
|
|
138
|
-
# the call, unless it is LOGIC_FAILED
|
|
167
|
+
# the call, unless it is LOGIC_FAILED, your own logic failing, or
|
|
168
|
+
# WEBHOOK_ADDRESS_REFUSED, the address you sent.
|
|
139
169
|
def error_class(status, code)
|
|
140
170
|
return code == RECONNECT_ERROR_CODE ? ReconnectError : NotAvailableError if status == 409
|
|
141
|
-
return code
|
|
171
|
+
return unprocessable_class(code) if status == 422
|
|
142
172
|
|
|
143
173
|
CLASS_BY_STATUS.fetch(status, ServerError)
|
|
144
174
|
end
|
|
145
175
|
|
|
176
|
+
def unprocessable_class(code)
|
|
177
|
+
case code
|
|
178
|
+
when LOGIC_FAILED_ERROR_CODE then LogicFailedError
|
|
179
|
+
when WEBHOOK_ADDRESS_REFUSED_ERROR_CODE then InputError
|
|
180
|
+
else PlatformRefusedError
|
|
181
|
+
end
|
|
182
|
+
end
|
|
183
|
+
|
|
146
184
|
# Our shape is `{ "error" => { "code", "message", "details" } }`, as JSON
|
|
147
185
|
# parses it. Anything else reads as "not our shape".
|
|
148
186
|
def read_error_shape(body)
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Appnigma
|
|
4
|
+
# Which features are on for your company: `client.features.list` (24.2). A
|
|
5
|
+
# read, so it is retried.
|
|
6
|
+
class Features
|
|
7
|
+
def initialize(client)
|
|
8
|
+
@client = client
|
|
9
|
+
end
|
|
10
|
+
|
|
11
|
+
# Each feature as `{ name:, enabled: }`, so your page can hide what is
|
|
12
|
+
# off: the calls of a feature that is off are refused. `portal` is the
|
|
13
|
+
# custom logic portal, opened with `portal.create_link`; `sync` is
|
|
14
|
+
# noticing changes in end customers' accounts, switched on with `sync.set`.
|
|
15
|
+
def list(timeout_ms: nil)
|
|
16
|
+
@client.call(:list_features, timeout_ms: timeout_ms)
|
|
17
|
+
end
|
|
18
|
+
end
|
|
19
|
+
end
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require "fileutils"
|
|
4
|
+
|
|
5
|
+
module Appnigma
|
|
6
|
+
# Writing the `appnigma` command's files into a customer's project (24.3).
|
|
7
|
+
module Files
|
|
8
|
+
# What a command wrote: where, how many functions and actions it
|
|
9
|
+
# describes, and why the actions could not be read, when they could not.
|
|
10
|
+
WriteResult = Struct.new(:path, :function_count, :action_count, :actions_unread_because, keyword_init: true)
|
|
11
|
+
|
|
12
|
+
module_function
|
|
13
|
+
|
|
14
|
+
# Writes the file so that one which exists is always whole: the text goes
|
|
15
|
+
# to a temporary name beside the target, then is renamed into place. The
|
|
16
|
+
# folder is made if it is missing. Answers the resolved path.
|
|
17
|
+
def write_atomically(out_path, text)
|
|
18
|
+
resolved = File.expand_path(out_path)
|
|
19
|
+
FileUtils.mkdir_p(File.dirname(resolved))
|
|
20
|
+
temporary = "#{resolved}.#{Process.pid}.tmp"
|
|
21
|
+
File.write(temporary, text, encoding: "UTF-8")
|
|
22
|
+
File.rename(temporary, resolved)
|
|
23
|
+
resolved
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
end
|