aws-sdk-payments 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.
@@ -0,0 +1,15 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ require 'aws-sdk-core/waiters'
11
+
12
+ module Aws::Payments
13
+ module Waiters
14
+ end
15
+ end
@@ -0,0 +1,62 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+
11
+ require 'aws-sdk-core'
12
+ require 'aws-sigv4'
13
+
14
+ Aws::Plugins::GlobalConfiguration.add_identifier(:payments)
15
+
16
+ # This module provides support for AWS Payments. This module is available in the
17
+ # `aws-sdk-payments` gem.
18
+ #
19
+ # # Client
20
+ #
21
+ # The {Client} class provides one method for each API operation. Operation
22
+ # methods each accept a hash of request parameters and return a response
23
+ # structure.
24
+ #
25
+ # payments = Aws::Payments::Client.new
26
+ # resp = payments.batch_get_financial_record(params)
27
+ #
28
+ # See {Client} for more information.
29
+ #
30
+ # # Errors
31
+ #
32
+ # Errors returned from AWS Payments are defined in the
33
+ # {Errors} module and all extend {Errors::ServiceError}.
34
+ #
35
+ # begin
36
+ # # do stuff
37
+ # rescue Aws::Payments::Errors::ServiceError
38
+ # # rescues all AWS Payments API errors
39
+ # end
40
+ #
41
+ # See {Errors} for more information.
42
+ #
43
+ # @!group service
44
+ module Aws::Payments
45
+ autoload :Types, 'aws-sdk-payments/types'
46
+ autoload :ClientApi, 'aws-sdk-payments/client_api'
47
+ module Plugins
48
+ autoload :Endpoints, 'aws-sdk-payments/plugins/endpoints.rb'
49
+ end
50
+ autoload :Client, 'aws-sdk-payments/client'
51
+ autoload :Errors, 'aws-sdk-payments/errors'
52
+ autoload :Waiters, 'aws-sdk-payments/waiters'
53
+ autoload :Resource, 'aws-sdk-payments/resource'
54
+ autoload :EndpointParameters, 'aws-sdk-payments/endpoint_parameters'
55
+ autoload :EndpointProvider, 'aws-sdk-payments/endpoint_provider'
56
+ autoload :Endpoints, 'aws-sdk-payments/endpoints'
57
+
58
+ GEM_VERSION = '1.0.0'
59
+
60
+ end
61
+
62
+ require_relative 'aws-sdk-payments/customizations'
data/sig/client.rbs ADDED
@@ -0,0 +1,165 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws
9
+ module Payments
10
+ class Client < ::Seahorse::Client::Base
11
+ include ::Aws::ClientStubs
12
+
13
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Payments/Client.html#initialize-instance_method
14
+ def self.new: (
15
+ ?credentials: untyped,
16
+ ?region: String,
17
+ ?access_key_id: String,
18
+ ?account_id: String,
19
+ ?active_endpoint_cache: bool,
20
+ ?adaptive_retry_wait_to_fill: bool,
21
+ ?auth_scheme_preference: Array[String],
22
+ ?client_side_monitoring: bool,
23
+ ?client_side_monitoring_client_id: String,
24
+ ?client_side_monitoring_host: String,
25
+ ?client_side_monitoring_port: Integer,
26
+ ?client_side_monitoring_publisher: untyped,
27
+ ?convert_params: bool,
28
+ ?correct_clock_skew: bool,
29
+ ?defaults_mode: String,
30
+ ?disable_clock_skew_correction: bool,
31
+ ?disable_host_prefix_injection: bool,
32
+ ?disable_request_compression: bool,
33
+ ?endpoint: String,
34
+ ?endpoint_cache_max_entries: Integer,
35
+ ?endpoint_cache_max_threads: Integer,
36
+ ?endpoint_cache_poll_interval: Integer,
37
+ ?endpoint_discovery: bool,
38
+ ?ignore_configured_endpoint_urls: bool,
39
+ ?log_formatter: untyped,
40
+ ?log_level: Symbol,
41
+ ?logger: untyped,
42
+ ?max_attempts: Integer,
43
+ ?profile: String,
44
+ ?request_checksum_calculation: String,
45
+ ?request_min_compression_size_bytes: Integer,
46
+ ?response_checksum_validation: String,
47
+ ?retry_backoff: Proc,
48
+ ?retry_base_delay: Float,
49
+ ?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
50
+ ?retry_limit: Integer,
51
+ ?retry_max_delay: Integer,
52
+ ?retry_mode: ("legacy" | "standard" | "adaptive"),
53
+ ?sdk_ua_app_id: String,
54
+ ?secret_access_key: String,
55
+ ?session_token: String,
56
+ ?sigv4a_signing_region_set: Array[String],
57
+ ?simple_json: bool,
58
+ ?stub_responses: untyped,
59
+ ?telemetry_provider: Aws::Telemetry::TelemetryProviderBase,
60
+ ?token_provider: untyped,
61
+ ?use_dualstack_endpoint: bool,
62
+ ?use_fips_endpoint: bool,
63
+ ?validate_params: bool,
64
+ ?endpoint_provider: untyped,
65
+ ?http_proxy: String,
66
+ ?http_open_timeout: (Float | Integer),
67
+ ?http_read_timeout: (Float | Integer),
68
+ ?http_idle_timeout: (Float | Integer),
69
+ ?http_continue_timeout: (Float | Integer),
70
+ ?ssl_timeout: (Float | Integer | nil),
71
+ ?http_wire_trace: bool,
72
+ ?ssl_verify_peer: bool,
73
+ ?ssl_ca_bundle: String,
74
+ ?ssl_ca_directory: String,
75
+ ?ssl_ca_store: String,
76
+ ?on_chunk_received: Proc,
77
+ ?on_chunk_sent: Proc,
78
+ ?raise_response_errors: bool
79
+ ) -> instance
80
+ | (?Hash[Symbol, untyped]) -> instance
81
+
82
+
83
+ interface _BatchGetFinancialRecordResponseSuccess
84
+ include ::Seahorse::Client::_ResponseSuccess[Types::BatchGetFinancialRecordResponse]
85
+ def financial_records: () -> ::Array[Types::FinancialRecord]
86
+ def errors: () -> ::Array[Types::FinancialRecordError]
87
+ end
88
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Payments/Client.html#batch_get_financial_record-instance_method
89
+ def batch_get_financial_record: (
90
+ keys: Array[
91
+ {
92
+ identifier: ::String?,
93
+ invoice_identifier: ::String?
94
+ }
95
+ ]
96
+ ) -> _BatchGetFinancialRecordResponseSuccess
97
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _BatchGetFinancialRecordResponseSuccess
98
+
99
+ interface _GetAccountBalanceResponseSuccess
100
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetAccountBalanceResponse]
101
+ def account_balances: () -> ::Array[Types::AccountBalance]
102
+ def next_token: () -> ::String
103
+ end
104
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Payments/Client.html#get_account_balance-instance_method
105
+ def get_account_balance: (
106
+ balance_type: ("INVOICES_DUE" | "INVOICES_PAST_DUE" | "OUTSTANDING_CREDIT_MEMOS"),
107
+ ?next_token: ::String,
108
+ ?max_results: ::Integer
109
+ ) -> _GetAccountBalanceResponseSuccess
110
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetAccountBalanceResponseSuccess
111
+
112
+ interface _GetFinancialRecordResponseSuccess
113
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetFinancialRecordResponse]
114
+ def financial_record: () -> Types::FinancialRecord
115
+ end
116
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Payments/Client.html#get_financial_record-instance_method
117
+ def get_financial_record: (
118
+ ?identifier: ::String,
119
+ ?invoice_identifier: ::String
120
+ ) -> _GetFinancialRecordResponseSuccess
121
+ | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetFinancialRecordResponseSuccess
122
+
123
+ interface _GetPaymentInstrumentResponseSuccess
124
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetPaymentInstrumentResponse]
125
+ def payment_instrument: () -> Types::PaymentInstrument
126
+ end
127
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Payments/Client.html#get_payment_instrument-instance_method
128
+ def get_payment_instrument: (
129
+ identifier: ::String
130
+ ) -> _GetPaymentInstrumentResponseSuccess
131
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetPaymentInstrumentResponseSuccess
132
+
133
+ interface _ListFinancialRecordsResponseSuccess
134
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListFinancialRecordsResponse]
135
+ def financial_record_summaries: () -> ::Array[Types::FinancialRecordSummary]
136
+ def next_token: () -> ::String
137
+ end
138
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Payments/Client.html#list_financial_records-instance_method
139
+ def list_financial_records: (
140
+ types: Array[("INVOICE" | "CREDIT_MEMO")],
141
+ ?settlement_statuses: Array[("OPEN" | "CLOSED")],
142
+ ?issued_after: ::Time,
143
+ ?issued_before: ::Time,
144
+ ?sort_by: ("ISSUED_AT"),
145
+ ?sort_order: ("ASCENDING" | "DESCENDING"),
146
+ ?next_token: ::String,
147
+ ?max_results: ::Integer
148
+ ) -> _ListFinancialRecordsResponseSuccess
149
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListFinancialRecordsResponseSuccess
150
+
151
+ interface _ListPaymentInstrumentsResponseSuccess
152
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListPaymentInstrumentsResponse]
153
+ def payment_instrument_summaries: () -> ::Array[Types::PaymentInstrumentSummary]
154
+ def next_token: () -> ::String
155
+ end
156
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Payments/Client.html#list_payment_instruments-instance_method
157
+ def list_payment_instruments: (
158
+ ?next_token: ::String,
159
+ ?max_results: ::Integer
160
+ ) -> _ListPaymentInstrumentsResponseSuccess
161
+ | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListPaymentInstrumentsResponseSuccess
162
+ end
163
+ end
164
+ end
165
+
data/sig/errors.rbs ADDED
@@ -0,0 +1,38 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws
9
+ module Payments
10
+ module Errors
11
+ class ServiceError < ::Aws::Errors::ServiceError
12
+ end
13
+
14
+ class AccessDeniedException < ServiceError
15
+ def message: () -> ::String
16
+ def reason: () -> ::String
17
+ end
18
+ class InternalServerException < ServiceError
19
+ def message: () -> ::String
20
+ def retry_after_seconds: () -> ::String
21
+ end
22
+ class ResourceNotFoundException < ServiceError
23
+ def message: () -> ::String
24
+ def resource_id: () -> ::String
25
+ def resource_type: () -> ::String
26
+ end
27
+ class ThrottlingException < ServiceError
28
+ def message: () -> ::String
29
+ def retry_after_seconds: () -> ::String
30
+ end
31
+ class ValidationException < ServiceError
32
+ def message: () -> ::String
33
+ def reason: () -> ::String
34
+ def field_list: () -> ::String
35
+ end
36
+ end
37
+ end
38
+ end
data/sig/resource.rbs ADDED
@@ -0,0 +1,87 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws
9
+ module Payments
10
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Payments/Resource.html
11
+ class Resource
12
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Payments/Resource.html#initialize-instance_method
13
+ def initialize: (
14
+ ?client: Client,
15
+ ?credentials: untyped,
16
+ ?region: String,
17
+ ?access_key_id: String,
18
+ ?account_id: String,
19
+ ?active_endpoint_cache: bool,
20
+ ?adaptive_retry_wait_to_fill: bool,
21
+ ?auth_scheme_preference: Array[String],
22
+ ?client_side_monitoring: bool,
23
+ ?client_side_monitoring_client_id: String,
24
+ ?client_side_monitoring_host: String,
25
+ ?client_side_monitoring_port: Integer,
26
+ ?client_side_monitoring_publisher: untyped,
27
+ ?convert_params: bool,
28
+ ?correct_clock_skew: bool,
29
+ ?defaults_mode: String,
30
+ ?disable_clock_skew_correction: bool,
31
+ ?disable_host_prefix_injection: bool,
32
+ ?disable_request_compression: bool,
33
+ ?endpoint: String,
34
+ ?endpoint_cache_max_entries: Integer,
35
+ ?endpoint_cache_max_threads: Integer,
36
+ ?endpoint_cache_poll_interval: Integer,
37
+ ?endpoint_discovery: bool,
38
+ ?ignore_configured_endpoint_urls: bool,
39
+ ?log_formatter: untyped,
40
+ ?log_level: Symbol,
41
+ ?logger: untyped,
42
+ ?max_attempts: Integer,
43
+ ?profile: String,
44
+ ?request_checksum_calculation: String,
45
+ ?request_min_compression_size_bytes: Integer,
46
+ ?response_checksum_validation: String,
47
+ ?retry_backoff: Proc,
48
+ ?retry_base_delay: Float,
49
+ ?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
50
+ ?retry_limit: Integer,
51
+ ?retry_max_delay: Integer,
52
+ ?retry_mode: ("legacy" | "standard" | "adaptive"),
53
+ ?sdk_ua_app_id: String,
54
+ ?secret_access_key: String,
55
+ ?session_token: String,
56
+ ?sigv4a_signing_region_set: Array[String],
57
+ ?simple_json: bool,
58
+ ?stub_responses: untyped,
59
+ ?telemetry_provider: Aws::Telemetry::TelemetryProviderBase,
60
+ ?token_provider: untyped,
61
+ ?use_dualstack_endpoint: bool,
62
+ ?use_fips_endpoint: bool,
63
+ ?validate_params: bool,
64
+ ?endpoint_provider: untyped,
65
+ ?http_proxy: String,
66
+ ?http_open_timeout: (Float | Integer),
67
+ ?http_read_timeout: (Float | Integer),
68
+ ?http_idle_timeout: (Float | Integer),
69
+ ?http_continue_timeout: (Float | Integer),
70
+ ?ssl_timeout: (Float | Integer | nil),
71
+ ?http_wire_trace: bool,
72
+ ?ssl_verify_peer: bool,
73
+ ?ssl_ca_bundle: String,
74
+ ?ssl_ca_directory: String,
75
+ ?ssl_ca_store: String,
76
+ ?on_chunk_received: Proc,
77
+ ?on_chunk_sent: Proc,
78
+ ?raise_response_errors: bool
79
+ ) -> void
80
+ | (?Hash[Symbol, untyped]) -> void
81
+
82
+ def client: () -> Client
83
+
84
+
85
+ end
86
+ end
87
+ end