sumup 0.0.1

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 (44) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +18 -0
  3. data/LICENSE +201 -0
  4. data/README.md +188 -0
  5. data/lib/sumup/client.rb +213 -0
  6. data/lib/sumup/errors.rb +45 -0
  7. data/lib/sumup/event_types.rb +115 -0
  8. data/lib/sumup/events.rb +168 -0
  9. data/lib/sumup/model.rb +109 -0
  10. data/lib/sumup/pagination.rb +92 -0
  11. data/lib/sumup/resource.rb +36 -0
  12. data/lib/sumup/resources/checkouts.rb +155 -0
  13. data/lib/sumup/resources/customers.rb +89 -0
  14. data/lib/sumup/resources/members.rb +93 -0
  15. data/lib/sumup/resources/memberships.rb +23 -0
  16. data/lib/sumup/resources/merchants.rb +51 -0
  17. data/lib/sumup/resources/payouts.rb +29 -0
  18. data/lib/sumup/resources/readers.rb +264 -0
  19. data/lib/sumup/resources/receipts.rb +23 -0
  20. data/lib/sumup/resources/roles.rb +89 -0
  21. data/lib/sumup/resources/sales.rb +66 -0
  22. data/lib/sumup/resources/tokens.rb +31 -0
  23. data/lib/sumup/resources/transactions.rb +61 -0
  24. data/lib/sumup/resources.rb +83 -0
  25. data/lib/sumup/transport.rb +40 -0
  26. data/lib/sumup/types.rb +4720 -0
  27. data/lib/sumup/version.rb +5 -0
  28. data/lib/sumup.rb +13 -0
  29. data/sig/sumup/events.rbs +64 -0
  30. data/sig/sumup/resources/checkouts.rbs +35 -0
  31. data/sig/sumup/resources/customers.rbs +25 -0
  32. data/sig/sumup/resources/members.rbs +25 -0
  33. data/sig/sumup/resources/memberships.rbs +13 -0
  34. data/sig/sumup/resources/merchants.rbs +17 -0
  35. data/sig/sumup/resources/payouts.rbs +13 -0
  36. data/sig/sumup/resources/readers.rbs +45 -0
  37. data/sig/sumup/resources/receipts.rbs +13 -0
  38. data/sig/sumup/resources/roles.rbs +25 -0
  39. data/sig/sumup/resources/sales.rbs +19 -0
  40. data/sig/sumup/resources/tokens.rbs +15 -0
  41. data/sig/sumup/resources/transactions.rbs +19 -0
  42. data/sig/sumup/types.rbs +1635 -0
  43. data/sig/sumup.rbs +183 -0
  44. metadata +149 -0
data/sig/sumup.rbs ADDED
@@ -0,0 +1,183 @@
1
+ module SumUp
2
+ VERSION: String
3
+ UNSET: Object
4
+ type request_options = RequestOptions | Hash[Symbol, untyped] | nil
5
+ type attributes = Hash[Symbol | String, untyped]
6
+
7
+ class Model
8
+ def self.fields: () -> Hash[Symbol, untyped]
9
+ def self.from_hash: (attributes) -> instance
10
+ def initialize: (?attributes, **untyped) -> void
11
+ def []: (String | Symbol) -> untyped
12
+ def key?: (String | Symbol) -> bool
13
+ def to_h: () -> Hash[String, untyped]
14
+ def to_json: (*untyped) -> String
15
+ def inspect: () -> String
16
+ def ==: (untyped) -> bool
17
+ end
18
+
19
+ module Types
20
+ def self.encode: (untyped) -> untyped
21
+ def self.decode: (untyped, untyped) -> untyped
22
+ end
23
+
24
+ class RequestOptions
25
+ attr_reader headers: Hash[String | Symbol, String]
26
+ attr_reader api_key: String?
27
+ attr_reader timeout: Numeric?
28
+ attr_reader open_timeout: Numeric?
29
+ attr_reader max_retries: Integer?
30
+ def initialize: (?headers: Hash[String | Symbol, String], ?api_key: String?, ?timeout: Numeric?, ?open_timeout: Numeric?, ?max_retries: Integer?) -> void
31
+ def inspect: () -> String
32
+ end
33
+
34
+ class Request < Data
35
+ attr_reader method: String
36
+ attr_reader uri: untyped
37
+ attr_reader headers: Hash[String, String]
38
+ attr_reader body: String?
39
+ attr_reader open_timeout: Numeric
40
+ attr_reader read_timeout: Numeric
41
+ attr_reader write_timeout: Numeric
42
+ def self.new: (method: String, uri: untyped, headers: Hash[String, String], body: String?, open_timeout: Numeric, read_timeout: Numeric, write_timeout: Numeric) -> instance
43
+ end
44
+
45
+ class HTTPResponse < Data
46
+ attr_reader status: Integer
47
+ attr_reader headers: Hash[String, String]
48
+ attr_reader body: String
49
+ def self.new: (status: Integer, headers: Hash[String, String], body: String) -> instance
50
+ end
51
+
52
+ interface _Transport
53
+ def call: (Request) -> HTTPResponse
54
+ end
55
+
56
+ class NetHTTPTransport
57
+ def call: (Request) -> HTTPResponse
58
+ end
59
+
60
+ class Response[out A] < Data
61
+ attr_reader data: A
62
+ attr_reader status: Integer
63
+ attr_reader headers: Hash[String, String]
64
+ attr_reader body: String
65
+ def request_id: () -> String?
66
+ def inspect: () -> String
67
+ end
68
+
69
+ class Client
70
+ DEFAULT_BASE_URL: String
71
+ attr_reader base_url: String
72
+ def initialize: (?api_key: String?, ?base_url: String, ?timeout: Numeric, ?open_timeout: Numeric, ?max_retries: Integer, ?transport: _Transport, ?headers: Hash[String | Symbol, String], ?sleeper: ^(Numeric) -> untyped) -> void
73
+ def request: (method: String, path: String, ?query: attributes, ?body: untyped, ?options: request_options, ?response_type: untyped, ?with_response: bool) -> untyped
74
+ def events_handler: (secret: String, fallback: ^(EventNotification) -> untyped) ?{ (EventsHandler) -> untyped } -> EventsHandler
75
+ def parse_event_notification_without_verification: (String) -> EventNotification
76
+ def inspect: () -> String
77
+ end
78
+
79
+ class Resource
80
+ def initialize: (Client) -> void
81
+ def inspect: () -> String
82
+ end
83
+
84
+ class Error < StandardError
85
+ end
86
+ class APIConnectionError < Error
87
+ end
88
+ class APITimeoutError < APIConnectionError
89
+ end
90
+ class InvalidResponseError < Error
91
+ end
92
+ class APIError < Error
93
+ attr_reader status: Integer
94
+ attr_reader body: untyped
95
+ attr_reader headers: Hash[String, String]
96
+ attr_reader request_id: String?
97
+ attr_reader problem: Types::Problem?
98
+ def initialize: (status: Integer, body: untyped, ?headers: Hash[String, String]) -> void
99
+ end
100
+ class APIStatusError < APIError
101
+ end
102
+ class BadRequestError < APIStatusError
103
+ end
104
+ class AuthenticationError < APIStatusError
105
+ end
106
+ class PermissionDeniedError < APIStatusError
107
+ end
108
+ class NotFoundError < APIStatusError
109
+ end
110
+ class ConflictError < APIStatusError
111
+ end
112
+ class UnprocessableEntityError < APIStatusError
113
+ end
114
+ class RateLimitError < APIStatusError
115
+ end
116
+ class InternalServerError < APIStatusError
117
+ end
118
+
119
+ class EventError < Error
120
+ end
121
+ class EventSignatureError < EventError
122
+ end
123
+ class EventTimestampError < EventSignatureError
124
+ end
125
+ class EventSignatureExpiredError < EventSignatureError
126
+ end
127
+ class EventPayloadError < EventError
128
+ end
129
+ class EventCallbackError < EventError
130
+ end
131
+ class EventObjectURLError < EventError
132
+ end
133
+
134
+ class EventNotification
135
+ attr_reader id: String
136
+ attr_reader type: String
137
+ attr_reader created_at: Time
138
+ attr_reader object: Types::EventObject
139
+ def fetch_object: (?options: request_options) -> Model
140
+ def to_h: () -> Hash[String, untyped]
141
+ def inspect: () -> String
142
+ end
143
+ class UnknownEvent < EventNotification
144
+ end
145
+
146
+ module Events
147
+ SIGNATURE_HEADER: String
148
+ TOLERANCE_SECONDS: Integer
149
+ def self.verify_signature: (secret: String, body: String, signature: String?) -> bool
150
+ def self.parse: (secret: String, body: String, signature: String?, client: Client) -> EventNotification
151
+ def self.parse_without_verification: (String, client: Client) -> EventNotification
152
+ end
153
+
154
+ class EventsHandler
155
+ def initialize: (client: Client, secret: String, fallback: ^(EventNotification) -> untyped) -> void
156
+ def on: (String, ^(EventNotification) -> untyped) -> self
157
+ | (String) { (EventNotification) -> untyped } -> self
158
+ def parse: (String, signature: String?) -> EventNotification
159
+ def handle: (String, signature: String?) -> EventNotification
160
+ def inspect: () -> String
161
+ end
162
+
163
+ module Resources
164
+ class Sales < Resource
165
+ def each: (**untyped) -> Enumerator[Types::Sale, untyped]
166
+ | (**untyped) { (Types::Sale) -> untyped } -> untyped
167
+ def search_each: (**untyped) -> Enumerator[Types::SaleSearchItem, untyped]
168
+ | (**untyped) { (Types::SaleSearchItem) -> untyped } -> untyped
169
+ end
170
+ class Transactions < Resource
171
+ def each: (**untyped) -> Enumerator[Types::TransactionHistory, untyped]
172
+ | (**untyped) { (Types::TransactionHistory) -> untyped } -> untyped
173
+ end
174
+ class Members < Resource
175
+ def each: (**untyped) -> Enumerator[Types::Member, untyped]
176
+ | (**untyped) { (Types::Member) -> untyped } -> untyped
177
+ end
178
+ class Memberships < Resource
179
+ def each: (**untyped) -> Enumerator[Types::Membership, untyped]
180
+ | (**untyped) { (Types::Membership) -> untyped } -> untyped
181
+ end
182
+ end
183
+ end
metadata ADDED
@@ -0,0 +1,149 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: sumup
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - SumUp
8
+ bindir: bin
9
+ cert_chain: []
10
+ date: 1980-01-02 00:00:00.000000000 Z
11
+ dependencies:
12
+ - !ruby/object:Gem::Dependency
13
+ name: json
14
+ requirement: !ruby/object:Gem::Requirement
15
+ requirements:
16
+ - - ">="
17
+ - !ruby/object:Gem::Version
18
+ version: '2.7'
19
+ - - "<"
20
+ - !ruby/object:Gem::Version
21
+ version: '3'
22
+ type: :runtime
23
+ prerelease: false
24
+ version_requirements: !ruby/object:Gem::Requirement
25
+ requirements:
26
+ - - ">="
27
+ - !ruby/object:Gem::Version
28
+ version: '2.7'
29
+ - - "<"
30
+ - !ruby/object:Gem::Version
31
+ version: '3'
32
+ - !ruby/object:Gem::Dependency
33
+ name: net-http
34
+ requirement: !ruby/object:Gem::Requirement
35
+ requirements:
36
+ - - ">="
37
+ - !ruby/object:Gem::Version
38
+ version: '0.4'
39
+ - - "<"
40
+ - !ruby/object:Gem::Version
41
+ version: '1'
42
+ type: :runtime
43
+ prerelease: false
44
+ version_requirements: !ruby/object:Gem::Requirement
45
+ requirements:
46
+ - - ">="
47
+ - !ruby/object:Gem::Version
48
+ version: '0.4'
49
+ - - "<"
50
+ - !ruby/object:Gem::Version
51
+ version: '1'
52
+ - !ruby/object:Gem::Dependency
53
+ name: openssl
54
+ requirement: !ruby/object:Gem::Requirement
55
+ requirements:
56
+ - - ">="
57
+ - !ruby/object:Gem::Version
58
+ version: '3.2'
59
+ - - "<"
60
+ - !ruby/object:Gem::Version
61
+ version: '5'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '3.2'
69
+ - - "<"
70
+ - !ruby/object:Gem::Version
71
+ version: '5'
72
+ description: Generated resource clients, models, and signed event handling for SumUp's
73
+ public API.
74
+ email:
75
+ - integration@sumup.com
76
+ executables: []
77
+ extensions: []
78
+ extra_rdoc_files: []
79
+ files:
80
+ - CHANGELOG.md
81
+ - LICENSE
82
+ - README.md
83
+ - lib/sumup.rb
84
+ - lib/sumup/client.rb
85
+ - lib/sumup/errors.rb
86
+ - lib/sumup/event_types.rb
87
+ - lib/sumup/events.rb
88
+ - lib/sumup/model.rb
89
+ - lib/sumup/pagination.rb
90
+ - lib/sumup/resource.rb
91
+ - lib/sumup/resources.rb
92
+ - lib/sumup/resources/checkouts.rb
93
+ - lib/sumup/resources/customers.rb
94
+ - lib/sumup/resources/members.rb
95
+ - lib/sumup/resources/memberships.rb
96
+ - lib/sumup/resources/merchants.rb
97
+ - lib/sumup/resources/payouts.rb
98
+ - lib/sumup/resources/readers.rb
99
+ - lib/sumup/resources/receipts.rb
100
+ - lib/sumup/resources/roles.rb
101
+ - lib/sumup/resources/sales.rb
102
+ - lib/sumup/resources/tokens.rb
103
+ - lib/sumup/resources/transactions.rb
104
+ - lib/sumup/transport.rb
105
+ - lib/sumup/types.rb
106
+ - lib/sumup/version.rb
107
+ - sig/sumup.rbs
108
+ - sig/sumup/events.rbs
109
+ - sig/sumup/resources/checkouts.rbs
110
+ - sig/sumup/resources/customers.rbs
111
+ - sig/sumup/resources/members.rbs
112
+ - sig/sumup/resources/memberships.rbs
113
+ - sig/sumup/resources/merchants.rbs
114
+ - sig/sumup/resources/payouts.rbs
115
+ - sig/sumup/resources/readers.rbs
116
+ - sig/sumup/resources/receipts.rbs
117
+ - sig/sumup/resources/roles.rbs
118
+ - sig/sumup/resources/sales.rbs
119
+ - sig/sumup/resources/tokens.rbs
120
+ - sig/sumup/resources/transactions.rbs
121
+ - sig/sumup/types.rbs
122
+ homepage: https://developer.sumup.com
123
+ licenses:
124
+ - Apache-2.0
125
+ metadata:
126
+ source_code_uri: https://github.com/sumup/sumup-ruby
127
+ bug_tracker_uri: https://github.com/sumup/sumup-ruby/issues
128
+ changelog_uri: https://github.com/sumup/sumup-ruby/blob/main/CHANGELOG.md
129
+ documentation_uri: https://developer.sumup.com
130
+ rubygems_mfa_required: 'true'
131
+ allowed_push_host: https://rubygems.org
132
+ rdoc_options: []
133
+ require_paths:
134
+ - lib
135
+ required_ruby_version: !ruby/object:Gem::Requirement
136
+ requirements:
137
+ - - ">="
138
+ - !ruby/object:Gem::Version
139
+ version: '3.3'
140
+ required_rubygems_version: !ruby/object:Gem::Requirement
141
+ requirements:
142
+ - - ">="
143
+ - !ruby/object:Gem::Version
144
+ version: '0'
145
+ requirements: []
146
+ rubygems_version: 4.0.23
147
+ specification_version: 4
148
+ summary: Ruby SDK for the SumUp API
149
+ test_files: []