appnigma-sdk 0.2.0 → 1.0.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 (70) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +18 -0
  3. data/README.md +90 -69
  4. data/lib/appnigma/client.rb +21 -28
  5. data/lib/appnigma/constants.rb +1 -0
  6. data/lib/appnigma/crm.rb +63 -6
  7. data/lib/appnigma/errors.rb +15 -0
  8. data/lib/appnigma/generated/api/default_api.rb +523 -61
  9. data/lib/appnigma/generated/api_client.rb +1 -1
  10. data/lib/appnigma/generated/api_error.rb +1 -1
  11. data/lib/appnigma/generated/api_model_base.rb +1 -1
  12. data/lib/appnigma/generated/configuration.rb +1 -1
  13. data/lib/appnigma/generated/models/action_entry.rb +341 -0
  14. data/lib/appnigma/generated/models/connection_status.rb +1 -1
  15. data/lib/appnigma/generated/models/create_connection_link_input.rb +1 -1
  16. data/lib/appnigma/generated/models/create_connection_link_output.rb +2 -2
  17. data/lib/appnigma/generated/models/crm_company.rb +1 -1
  18. data/lib/appnigma/generated/models/crm_company_get_output.rb +1 -1
  19. data/lib/appnigma/generated/models/crm_company_list_output.rb +1 -1
  20. data/lib/appnigma/generated/models/{post_output.rb → crm_company_write_output.rb} +20 -46
  21. data/lib/appnigma/generated/models/crm_contact.rb +1 -1
  22. data/lib/appnigma/generated/models/crm_contact_get_output.rb +1 -1
  23. data/lib/appnigma/generated/models/crm_contact_list_output.rb +1 -1
  24. data/lib/appnigma/generated/models/crm_contact_write_output.rb +177 -0
  25. data/lib/appnigma/generated/models/crm_create_input.rb +256 -0
  26. data/lib/appnigma/generated/models/crm_custom_field.rb +1 -1
  27. data/lib/appnigma/generated/models/crm_deal.rb +1 -1
  28. data/lib/appnigma/generated/models/{post_input.rb → crm_deal_create_input.rb} +48 -81
  29. data/lib/appnigma/generated/models/crm_deal_get_output.rb +1 -1
  30. data/lib/appnigma/generated/models/crm_deal_list_output.rb +1 -1
  31. data/lib/appnigma/generated/models/crm_deal_write_output.rb +177 -0
  32. data/lib/appnigma/generated/models/crm_email.rb +1 -1
  33. data/lib/appnigma/generated/models/crm_get_input.rb +1 -1
  34. data/lib/appnigma/generated/models/crm_labelled.rb +1 -1
  35. data/lib/appnigma/generated/models/crm_list_input.rb +1 -1
  36. data/lib/appnigma/generated/models/crm_phone.rb +1 -1
  37. data/lib/appnigma/generated/models/{pull_input.rb → crm_update_input.rb} +66 -100
  38. data/lib/appnigma/generated/models/function_entry.rb +1 -1
  39. data/lib/appnigma/generated/models/function_owner.rb +1 -1
  40. data/lib/appnigma/generated/models/function_owner_one_of.rb +1 -1
  41. data/lib/appnigma/generated/models/function_owner_one_of1.rb +1 -1
  42. data/lib/appnigma/generated/models/get_connection_output.rb +1 -1
  43. data/lib/appnigma/generated/models/get_guide_output.rb +1 -1
  44. data/lib/appnigma/generated/models/json_value.rb +1 -1
  45. data/lib/appnigma/generated/models/{pull_output_records_inner.rb → list_actions_output.rb} +21 -47
  46. data/lib/appnigma/generated/models/list_functions_output.rb +1 -1
  47. data/lib/appnigma/generated/models/list_platforms_output.rb +179 -0
  48. data/lib/appnigma/generated/models/platform_entry.rb +269 -0
  49. data/lib/appnigma/generated/models/platform_entry_coverage_inner.rb +219 -0
  50. data/lib/appnigma/generated/models/platform_request_input.rb +1 -1
  51. data/lib/appnigma/generated/models/platform_request_input_body.rb +1 -1
  52. data/lib/appnigma/generated/models/platform_request_output.rb +1 -1
  53. data/lib/appnigma/generated/models/ran_as.rb +4 -6
  54. data/lib/appnigma/generated/models/run_action_input.rb +277 -0
  55. data/lib/appnigma/generated/models/{pull_output.rb → run_action_output.rb} +21 -34
  56. data/lib/appnigma/generated/models/run_input.rb +3 -3
  57. data/lib/appnigma/generated/models/run_output.rb +1 -1
  58. data/lib/appnigma/generated/models/sdk_error.rb +1 -1
  59. data/lib/appnigma/generated/models/sdk_error_error.rb +3 -3
  60. data/lib/appnigma/generated/models/sdk_error_error_details.rb +32 -3
  61. data/lib/appnigma/generated/models/sdk_problem.rb +1 -1
  62. data/lib/appnigma/generated/version.rb +1 -1
  63. data/lib/appnigma/generated.rb +14 -7
  64. data/lib/appnigma/names.rb +9 -0
  65. data/lib/appnigma/platforms.rb +18 -0
  66. data/lib/appnigma/retry.rb +3 -3
  67. data/lib/appnigma/transport.rb +10 -4
  68. data/lib/appnigma/version.rb +2 -2
  69. metadata +15 -7
  70. data/lib/appnigma/generated/models/post_input_record_value.rb +0 -104
@@ -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: 2.0.0
6
+ The version of the OpenAPI document: 3.0.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.26.0
@@ -18,24 +18,31 @@ require 'appnigma/generated/version'
18
18
  require 'appnigma/generated/configuration'
19
19
 
20
20
  # Models
21
+ require 'appnigma/generated/models/action_entry'
21
22
  require 'appnigma/generated/models/connection_status'
22
23
  require 'appnigma/generated/models/create_connection_link_input'
23
24
  require 'appnigma/generated/models/create_connection_link_output'
24
25
  require 'appnigma/generated/models/crm_company'
25
26
  require 'appnigma/generated/models/crm_company_get_output'
26
27
  require 'appnigma/generated/models/crm_company_list_output'
28
+ require 'appnigma/generated/models/crm_company_write_output'
27
29
  require 'appnigma/generated/models/crm_contact'
28
30
  require 'appnigma/generated/models/crm_contact_get_output'
29
31
  require 'appnigma/generated/models/crm_contact_list_output'
32
+ require 'appnigma/generated/models/crm_contact_write_output'
33
+ require 'appnigma/generated/models/crm_create_input'
30
34
  require 'appnigma/generated/models/crm_custom_field'
31
35
  require 'appnigma/generated/models/crm_deal'
36
+ require 'appnigma/generated/models/crm_deal_create_input'
32
37
  require 'appnigma/generated/models/crm_deal_get_output'
33
38
  require 'appnigma/generated/models/crm_deal_list_output'
39
+ require 'appnigma/generated/models/crm_deal_write_output'
34
40
  require 'appnigma/generated/models/crm_email'
35
41
  require 'appnigma/generated/models/crm_get_input'
36
42
  require 'appnigma/generated/models/crm_labelled'
37
43
  require 'appnigma/generated/models/crm_list_input'
38
44
  require 'appnigma/generated/models/crm_phone'
45
+ require 'appnigma/generated/models/crm_update_input'
39
46
  require 'appnigma/generated/models/function_entry'
40
47
  require 'appnigma/generated/models/function_owner'
41
48
  require 'appnigma/generated/models/function_owner_one_of'
@@ -43,17 +50,17 @@ require 'appnigma/generated/models/function_owner_one_of1'
43
50
  require 'appnigma/generated/models/get_connection_output'
44
51
  require 'appnigma/generated/models/get_guide_output'
45
52
  require 'appnigma/generated/models/json_value'
53
+ require 'appnigma/generated/models/list_actions_output'
46
54
  require 'appnigma/generated/models/list_functions_output'
55
+ require 'appnigma/generated/models/list_platforms_output'
56
+ require 'appnigma/generated/models/platform_entry'
57
+ require 'appnigma/generated/models/platform_entry_coverage_inner'
47
58
  require 'appnigma/generated/models/platform_request_input'
48
59
  require 'appnigma/generated/models/platform_request_input_body'
49
60
  require 'appnigma/generated/models/platform_request_output'
50
- require 'appnigma/generated/models/post_input'
51
- require 'appnigma/generated/models/post_input_record_value'
52
- require 'appnigma/generated/models/post_output'
53
- require 'appnigma/generated/models/pull_input'
54
- require 'appnigma/generated/models/pull_output'
55
- require 'appnigma/generated/models/pull_output_records_inner'
56
61
  require 'appnigma/generated/models/ran_as'
62
+ require 'appnigma/generated/models/run_action_input'
63
+ require 'appnigma/generated/models/run_action_output'
57
64
  require 'appnigma/generated/models/run_input'
58
65
  require 'appnigma/generated/models/run_output'
59
66
  require 'appnigma/generated/models/sdk_error'
@@ -58,5 +58,14 @@ module Appnigma
58
58
  def camel_keys(hash)
59
59
  hash.compact.to_h { |key, value| [to_camel(key), value] }
60
60
  end
61
+
62
+ # A record to write: its fields become the wire's names, and a nil stays,
63
+ # because it clears the field. Anything but a Hash is sent as it is, for
64
+ # the server to refuse with its reason.
65
+ def record_keys(record)
66
+ return record unless record.is_a?(Hash)
67
+
68
+ record.to_h { |key, value| [to_camel(key), value] }
69
+ end
61
70
  end
62
71
  end
@@ -0,0 +1,18 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Appnigma
4
+ # The platforms switched on for you, and what each one covers:
5
+ # `client.platforms.list`. A read, so it is retried.
6
+ class Platforms
7
+ def initialize(client)
8
+ @client = client
9
+ end
10
+
11
+ # Each platform with its `support`: `supported` when an adapter reads
12
+ # and writes it in the shared shapes, with `coverage` naming each object
13
+ # and its actions, or `experimental` when only `request` reaches it.
14
+ def list(timeout_ms: nil)
15
+ @client.call(:list_platforms, timeout_ms: timeout_ms)
16
+ end
17
+ end
18
+ end
@@ -4,9 +4,9 @@ require_relative "errors"
4
4
 
5
5
  module Appnigma
6
6
  # Tries again only when trying again is safe: the network failed, the
7
- # server answered 5xx, or it answered 429. Never on 400, 401, 403, 404, 409
8
- # or 410, because the same request would be refused the same way. The same
9
- # rules, waits and jitter as the TypeScript package.
7
+ # server answered 5xx, or it answered 429. Never on 400, 401, 403, 404, 409,
8
+ # 410 or 422, because the same request would be refused the same way. The
9
+ # same rules, waits and jitter as the TypeScript package.
10
10
  module Retry
11
11
  # The wait before each retry when the server sent no Retry-After, with
12
12
  # the last one repeated when there are more retries than steps.
@@ -35,6 +35,9 @@ module Appnigma
35
35
  class Transport
36
36
  USER_AGENT = "appnigma-sdk-ruby/#{VERSION}".freeze
37
37
 
38
+ # A Retry-After of plain whole or part seconds; see read_retry_after.
39
+ RETRY_AFTER_SECONDS = /\A\d+(\.\d+)?\z/
40
+
38
41
  # Builds the generated API for one configuration. Tests pass their own.
39
42
  DEFAULT_API_FACTORY = ->(config) { Generated::DefaultApi.new(Generated::ApiClient.new(config)) }
40
43
 
@@ -117,12 +120,15 @@ module Appnigma
117
120
  end
118
121
 
119
122
  # Our server sends seconds. Anything else (an HTTP date from a proxy,
120
- # junk) reads as "not given" rather than as a wait.
123
+ # junk) reads as "not given" rather than as a wait, as in the TypeScript
124
+ # package. Only plain decimals count (RETRY_AFTER_SECONDS): Float() reads
125
+ # "0x10" as 16, and "1e3" and "1_000" as 1000.
121
126
  def read_retry_after(value)
122
- return nil if value.nil?
127
+ value = value&.strip
128
+ return nil unless value&.match?(RETRY_AFTER_SECONDS)
123
129
 
124
- seconds = Float(value, exception: false)
125
- return nil if seconds.nil? || !seconds.finite? || seconds.negative?
130
+ seconds = Float(value)
131
+ return nil unless seconds.finite?
126
132
 
127
133
  seconds == seconds.floor ? seconds.to_i : seconds
128
134
  end
@@ -1,9 +1,9 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Appnigma
4
- VERSION = "0.2.0"
4
+ VERSION = "1.0.0" # x-release-please-version
5
5
 
6
6
  # The version of the API description (openapi/sdk-v1.yaml) this gem was
7
7
  # generated from. Written by bin/generate; a test ties it to the file.
8
- API_DESCRIPTION_VERSION = "2.0.0"
8
+ API_DESCRIPTION_VERSION = "3.0.0"
9
9
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: appnigma-sdk
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.0
4
+ version: 1.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Appnigma
@@ -82,24 +82,31 @@ files:
82
82
  - lib/appnigma/generated/api_error.rb
83
83
  - lib/appnigma/generated/api_model_base.rb
84
84
  - lib/appnigma/generated/configuration.rb
85
+ - lib/appnigma/generated/models/action_entry.rb
85
86
  - lib/appnigma/generated/models/connection_status.rb
86
87
  - lib/appnigma/generated/models/create_connection_link_input.rb
87
88
  - lib/appnigma/generated/models/create_connection_link_output.rb
88
89
  - lib/appnigma/generated/models/crm_company.rb
89
90
  - lib/appnigma/generated/models/crm_company_get_output.rb
90
91
  - lib/appnigma/generated/models/crm_company_list_output.rb
92
+ - lib/appnigma/generated/models/crm_company_write_output.rb
91
93
  - lib/appnigma/generated/models/crm_contact.rb
92
94
  - lib/appnigma/generated/models/crm_contact_get_output.rb
93
95
  - lib/appnigma/generated/models/crm_contact_list_output.rb
96
+ - lib/appnigma/generated/models/crm_contact_write_output.rb
97
+ - lib/appnigma/generated/models/crm_create_input.rb
94
98
  - lib/appnigma/generated/models/crm_custom_field.rb
95
99
  - lib/appnigma/generated/models/crm_deal.rb
100
+ - lib/appnigma/generated/models/crm_deal_create_input.rb
96
101
  - lib/appnigma/generated/models/crm_deal_get_output.rb
97
102
  - lib/appnigma/generated/models/crm_deal_list_output.rb
103
+ - lib/appnigma/generated/models/crm_deal_write_output.rb
98
104
  - lib/appnigma/generated/models/crm_email.rb
99
105
  - lib/appnigma/generated/models/crm_get_input.rb
100
106
  - lib/appnigma/generated/models/crm_labelled.rb
101
107
  - lib/appnigma/generated/models/crm_list_input.rb
102
108
  - lib/appnigma/generated/models/crm_phone.rb
109
+ - lib/appnigma/generated/models/crm_update_input.rb
103
110
  - lib/appnigma/generated/models/function_entry.rb
104
111
  - lib/appnigma/generated/models/function_owner.rb
105
112
  - lib/appnigma/generated/models/function_owner_one_of.rb
@@ -107,17 +114,17 @@ files:
107
114
  - lib/appnigma/generated/models/get_connection_output.rb
108
115
  - lib/appnigma/generated/models/get_guide_output.rb
109
116
  - lib/appnigma/generated/models/json_value.rb
117
+ - lib/appnigma/generated/models/list_actions_output.rb
110
118
  - lib/appnigma/generated/models/list_functions_output.rb
119
+ - lib/appnigma/generated/models/list_platforms_output.rb
120
+ - lib/appnigma/generated/models/platform_entry.rb
121
+ - lib/appnigma/generated/models/platform_entry_coverage_inner.rb
111
122
  - lib/appnigma/generated/models/platform_request_input.rb
112
123
  - lib/appnigma/generated/models/platform_request_input_body.rb
113
124
  - lib/appnigma/generated/models/platform_request_output.rb
114
- - lib/appnigma/generated/models/post_input.rb
115
- - lib/appnigma/generated/models/post_input_record_value.rb
116
- - lib/appnigma/generated/models/post_output.rb
117
- - lib/appnigma/generated/models/pull_input.rb
118
- - lib/appnigma/generated/models/pull_output.rb
119
- - lib/appnigma/generated/models/pull_output_records_inner.rb
120
125
  - lib/appnigma/generated/models/ran_as.rb
126
+ - lib/appnigma/generated/models/run_action_input.rb
127
+ - lib/appnigma/generated/models/run_action_output.rb
121
128
  - lib/appnigma/generated/models/run_input.rb
122
129
  - lib/appnigma/generated/models/run_output.rb
123
130
  - lib/appnigma/generated/models/sdk_error.rb
@@ -126,6 +133,7 @@ files:
126
133
  - lib/appnigma/generated/models/sdk_problem.rb
127
134
  - lib/appnigma/generated/version.rb
128
135
  - lib/appnigma/names.rb
136
+ - lib/appnigma/platforms.rb
129
137
  - lib/appnigma/retry.rb
130
138
  - lib/appnigma/transport.rb
131
139
  - lib/appnigma/version.rb
@@ -1,104 +0,0 @@
1
- =begin
2
- #Appnigma SDK API
3
-
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
-
6
- The version of the OpenAPI document: 2.0.0
7
-
8
- Generated by: https://openapi-generator.tech
9
- Generator version: 7.26.0
10
-
11
- =end
12
-
13
- require 'date'
14
- require 'time'
15
-
16
- module Appnigma::Generated
17
- module PostInputRecordValue
18
- class << self
19
- # List of class defined in anyOf (OpenAPI v3)
20
- def openapi_any_of
21
- [
22
- :'Boolean',
23
- :'Float',
24
- :'String'
25
- ]
26
- end
27
-
28
- # Builds the object
29
- # @param [Mixed] Data to be matched against the list of anyOf items
30
- # @return [Object] Returns the model or the data itself
31
- def build(data)
32
- # Go through the list of anyOf items and attempt to identify the appropriate one.
33
- # Note:
34
- # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
35
- # due to the way the deserialization is made in the base_object template (it just casts without verifying).
36
- # - TODO: scalar values are de facto behaving as if they were nullable.
37
- # - TODO: logging when debugging is set.
38
- openapi_any_of.each do |klass|
39
- begin
40
- next if klass == :AnyType # "nullable: true"
41
- return find_and_cast_into_type(klass, data)
42
- rescue # rescue all errors so we keep iterating even if the current item lookup raises
43
- end
44
- end
45
-
46
- openapi_any_of.include?(:AnyType) ? data : nil
47
- end
48
-
49
- private
50
-
51
- SchemaMismatchError = Class.new(StandardError)
52
-
53
- # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
54
- def find_and_cast_into_type(klass, data)
55
- return if data.nil?
56
-
57
- case klass.to_s
58
- when 'Boolean'
59
- return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
60
- when 'Float'
61
- return data if data.instance_of?(Float)
62
- when 'Integer'
63
- return data if data.instance_of?(Integer)
64
- when 'Time'
65
- return Time.parse(data)
66
- when 'Date'
67
- return Date.iso8601(data)
68
- when 'String'
69
- return data if data.instance_of?(String)
70
- when 'Object' # "type: object"
71
- return data if data.instance_of?(Hash)
72
- when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
73
- if data.instance_of?(Array)
74
- sub_type = Regexp.last_match[:sub_type]
75
- return data.map { |item| find_and_cast_into_type(sub_type, item) }
76
- end
77
- when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
78
- if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
79
- sub_type = Regexp.last_match[:sub_type]
80
- return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
81
- end
82
- else # model
83
- const = Appnigma::Generated.const_get(klass)
84
- if const
85
- if const.respond_to?(:openapi_any_of) # nested anyOf model
86
- model = const.build(data)
87
- return model if model
88
- else
89
- # raise if data contains keys that are not known to the model
90
- raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
91
- model = const.build_from_hash(data)
92
- return model if model
93
- end
94
- end
95
- end
96
-
97
- raise # if no match by now, raise
98
- rescue
99
- raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
100
- end
101
- end
102
- end
103
-
104
- end