aws-sdk-pinpoint 1.3.0 → 1.4.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/lib/aws-sdk-pinpoint.rb +1 -1
- data/lib/aws-sdk-pinpoint/client.rb +65 -1
- data/lib/aws-sdk-pinpoint/client_api.rb +26 -0
- data/lib/aws-sdk-pinpoint/types.rb +50 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 384dd200812be8c09432e0e9638dd4c938af8f68
|
4
|
+
data.tar.gz: f8c4f00100663348d8be73b8df964368928c8bdc
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 13a69d44a8450c1c48a7fccb2e5e32855326fda35b10bd001d8134b9ec06e4cba8684233f617782db2e00d4896ecda238fab1a95295a35b3f454249242d31ace
|
7
|
+
data.tar.gz: fd80a52dbbde737ffe9de7feb1ef44ca05803b57c67b4e875e55bfa1676f2485b84a3df19c8350dffc794e0b79cdab61a0adb32c27a931786bb9410af95d7f32
|
data/lib/aws-sdk-pinpoint.rb
CHANGED
@@ -1301,6 +1301,68 @@ module Aws::Pinpoint
|
|
1301
1301
|
req.send_request(options)
|
1302
1302
|
end
|
1303
1303
|
|
1304
|
+
# Deletes an endpoint.
|
1305
|
+
#
|
1306
|
+
# @option params [required, String] :application_id
|
1307
|
+
#
|
1308
|
+
# @option params [required, String] :endpoint_id
|
1309
|
+
#
|
1310
|
+
# @return [Types::DeleteEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1311
|
+
#
|
1312
|
+
# * {Types::DeleteEndpointResponse#endpoint_response #endpoint_response} => Types::EndpointResponse
|
1313
|
+
#
|
1314
|
+
# @example Request syntax with placeholder values
|
1315
|
+
#
|
1316
|
+
# resp = client.delete_endpoint({
|
1317
|
+
# application_id: "__string", # required
|
1318
|
+
# endpoint_id: "__string", # required
|
1319
|
+
# })
|
1320
|
+
#
|
1321
|
+
# @example Response structure
|
1322
|
+
#
|
1323
|
+
# resp.endpoint_response.address #=> String
|
1324
|
+
# resp.endpoint_response.application_id #=> String
|
1325
|
+
# resp.endpoint_response.attributes #=> Hash
|
1326
|
+
# resp.endpoint_response.attributes["__string"] #=> Array
|
1327
|
+
# resp.endpoint_response.attributes["__string"][0] #=> String
|
1328
|
+
# resp.endpoint_response.channel_type #=> String, one of "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "EMAIL", "BAIDU", "CUSTOM"
|
1329
|
+
# resp.endpoint_response.cohort_id #=> String
|
1330
|
+
# resp.endpoint_response.creation_date #=> String
|
1331
|
+
# resp.endpoint_response.demographic.app_version #=> String
|
1332
|
+
# resp.endpoint_response.demographic.locale #=> String
|
1333
|
+
# resp.endpoint_response.demographic.make #=> String
|
1334
|
+
# resp.endpoint_response.demographic.model #=> String
|
1335
|
+
# resp.endpoint_response.demographic.model_version #=> String
|
1336
|
+
# resp.endpoint_response.demographic.platform #=> String
|
1337
|
+
# resp.endpoint_response.demographic.platform_version #=> String
|
1338
|
+
# resp.endpoint_response.demographic.timezone #=> String
|
1339
|
+
# resp.endpoint_response.effective_date #=> String
|
1340
|
+
# resp.endpoint_response.endpoint_status #=> String
|
1341
|
+
# resp.endpoint_response.id #=> String
|
1342
|
+
# resp.endpoint_response.location.city #=> String
|
1343
|
+
# resp.endpoint_response.location.country #=> String
|
1344
|
+
# resp.endpoint_response.location.latitude #=> Float
|
1345
|
+
# resp.endpoint_response.location.longitude #=> Float
|
1346
|
+
# resp.endpoint_response.location.postal_code #=> String
|
1347
|
+
# resp.endpoint_response.location.region #=> String
|
1348
|
+
# resp.endpoint_response.metrics #=> Hash
|
1349
|
+
# resp.endpoint_response.metrics["__string"] #=> Float
|
1350
|
+
# resp.endpoint_response.opt_out #=> String
|
1351
|
+
# resp.endpoint_response.request_id #=> String
|
1352
|
+
# resp.endpoint_response.user.user_attributes #=> Hash
|
1353
|
+
# resp.endpoint_response.user.user_attributes["__string"] #=> Array
|
1354
|
+
# resp.endpoint_response.user.user_attributes["__string"][0] #=> String
|
1355
|
+
# resp.endpoint_response.user.user_id #=> String
|
1356
|
+
#
|
1357
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteEndpoint AWS API Documentation
|
1358
|
+
#
|
1359
|
+
# @overload delete_endpoint(params = {})
|
1360
|
+
# @param [Hash] params ({})
|
1361
|
+
def delete_endpoint(params = {}, options = {})
|
1362
|
+
req = build_request(:delete_endpoint, params)
|
1363
|
+
req.send_request(options)
|
1364
|
+
end
|
1365
|
+
|
1304
1366
|
# Deletes the event stream for an app.
|
1305
1367
|
#
|
1306
1368
|
# @option params [required, String] :application_id
|
@@ -3679,6 +3741,7 @@ module Aws::Pinpoint
|
|
3679
3741
|
# sms_message: {
|
3680
3742
|
# body: "__string",
|
3681
3743
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
3744
|
+
# origination_number: "__string",
|
3682
3745
|
# sender_id: "__string",
|
3683
3746
|
# substitutions: {
|
3684
3747
|
# "__string" => ["__string"],
|
@@ -3842,6 +3905,7 @@ module Aws::Pinpoint
|
|
3842
3905
|
# sms_message: {
|
3843
3906
|
# body: "__string",
|
3844
3907
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
3908
|
+
# origination_number: "__string",
|
3845
3909
|
# sender_id: "__string",
|
3846
3910
|
# substitutions: {
|
3847
3911
|
# "__string" => ["__string"],
|
@@ -5068,7 +5132,7 @@ module Aws::Pinpoint
|
|
5068
5132
|
params: params,
|
5069
5133
|
config: config)
|
5070
5134
|
context[:gem_name] = 'aws-sdk-pinpoint'
|
5071
|
-
context[:gem_version] = '1.
|
5135
|
+
context[:gem_version] = '1.4.0'
|
5072
5136
|
Seahorse::Client::Request.new(handlers, context)
|
5073
5137
|
end
|
5074
5138
|
|
@@ -76,6 +76,8 @@ module Aws::Pinpoint
|
|
76
76
|
DeleteCampaignResponse = Shapes::StructureShape.new(name: 'DeleteCampaignResponse')
|
77
77
|
DeleteEmailChannelRequest = Shapes::StructureShape.new(name: 'DeleteEmailChannelRequest')
|
78
78
|
DeleteEmailChannelResponse = Shapes::StructureShape.new(name: 'DeleteEmailChannelResponse')
|
79
|
+
DeleteEndpointRequest = Shapes::StructureShape.new(name: 'DeleteEndpointRequest')
|
80
|
+
DeleteEndpointResponse = Shapes::StructureShape.new(name: 'DeleteEndpointResponse')
|
79
81
|
DeleteEventStreamRequest = Shapes::StructureShape.new(name: 'DeleteEventStreamRequest')
|
80
82
|
DeleteEventStreamResponse = Shapes::StructureShape.new(name: 'DeleteEventStreamResponse')
|
81
83
|
DeleteGcmChannelRequest = Shapes::StructureShape.new(name: 'DeleteGcmChannelRequest')
|
@@ -691,6 +693,15 @@ module Aws::Pinpoint
|
|
691
693
|
DeleteEmailChannelResponse[:payload] = :email_channel_response
|
692
694
|
DeleteEmailChannelResponse[:payload_member] = DeleteEmailChannelResponse.member(:email_channel_response)
|
693
695
|
|
696
|
+
DeleteEndpointRequest.add_member(:application_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "application-id"))
|
697
|
+
DeleteEndpointRequest.add_member(:endpoint_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "endpoint-id"))
|
698
|
+
DeleteEndpointRequest.struct_class = Types::DeleteEndpointRequest
|
699
|
+
|
700
|
+
DeleteEndpointResponse.add_member(:endpoint_response, Shapes::ShapeRef.new(shape: EndpointResponse, required: true, location_name: "EndpointResponse"))
|
701
|
+
DeleteEndpointResponse.struct_class = Types::DeleteEndpointResponse
|
702
|
+
DeleteEndpointResponse[:payload] = :endpoint_response
|
703
|
+
DeleteEndpointResponse[:payload_member] = DeleteEndpointResponse.member(:endpoint_response)
|
704
|
+
|
694
705
|
DeleteEventStreamRequest.add_member(:application_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "application-id"))
|
695
706
|
DeleteEventStreamRequest.struct_class = Types::DeleteEventStreamRequest
|
696
707
|
|
@@ -1348,6 +1359,7 @@ module Aws::Pinpoint
|
|
1348
1359
|
|
1349
1360
|
SMSMessage.add_member(:body, Shapes::ShapeRef.new(shape: __string, location_name: "Body"))
|
1350
1361
|
SMSMessage.add_member(:message_type, Shapes::ShapeRef.new(shape: MessageType, location_name: "MessageType"))
|
1362
|
+
SMSMessage.add_member(:origination_number, Shapes::ShapeRef.new(shape: __string, location_name: "OriginationNumber"))
|
1351
1363
|
SMSMessage.add_member(:sender_id, Shapes::ShapeRef.new(shape: __string, location_name: "SenderId"))
|
1352
1364
|
SMSMessage.add_member(:substitutions, Shapes::ShapeRef.new(shape: MapOfListOf__string, location_name: "Substitutions"))
|
1353
1365
|
SMSMessage.struct_class = Types::SMSMessage
|
@@ -1852,6 +1864,20 @@ module Aws::Pinpoint
|
|
1852
1864
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1853
1865
|
end)
|
1854
1866
|
|
1867
|
+
api.add_operation(:delete_endpoint, Seahorse::Model::Operation.new.tap do |o|
|
1868
|
+
o.name = "DeleteEndpoint"
|
1869
|
+
o.http_method = "DELETE"
|
1870
|
+
o.http_request_uri = "/v1/apps/{application-id}/endpoints/{endpoint-id}"
|
1871
|
+
o.input = Shapes::ShapeRef.new(shape: DeleteEndpointRequest)
|
1872
|
+
o.output = Shapes::ShapeRef.new(shape: DeleteEndpointResponse)
|
1873
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
1874
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerErrorException)
|
1875
|
+
o.errors << Shapes::ShapeRef.new(shape: ForbiddenException)
|
1876
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
1877
|
+
o.errors << Shapes::ShapeRef.new(shape: MethodNotAllowedException)
|
1878
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1879
|
+
end)
|
1880
|
+
|
1855
1881
|
api.add_operation(:delete_event_stream, Seahorse::Model::Operation.new.tap do |o|
|
1856
1882
|
o.name = "DeleteEventStream"
|
1857
1883
|
o.http_method = "DELETE"
|
@@ -2502,6 +2502,39 @@ module Aws::Pinpoint
|
|
2502
2502
|
include Aws::Structure
|
2503
2503
|
end
|
2504
2504
|
|
2505
|
+
# @note When making an API call, you may pass DeleteEndpointRequest
|
2506
|
+
# data as a hash:
|
2507
|
+
#
|
2508
|
+
# {
|
2509
|
+
# application_id: "__string", # required
|
2510
|
+
# endpoint_id: "__string", # required
|
2511
|
+
# }
|
2512
|
+
#
|
2513
|
+
# @!attribute [rw] application_id
|
2514
|
+
# @return [String]
|
2515
|
+
#
|
2516
|
+
# @!attribute [rw] endpoint_id
|
2517
|
+
# @return [String]
|
2518
|
+
#
|
2519
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteEndpointRequest AWS API Documentation
|
2520
|
+
#
|
2521
|
+
class DeleteEndpointRequest < Struct.new(
|
2522
|
+
:application_id,
|
2523
|
+
:endpoint_id)
|
2524
|
+
include Aws::Structure
|
2525
|
+
end
|
2526
|
+
|
2527
|
+
# @!attribute [rw] endpoint_response
|
2528
|
+
# Endpoint response
|
2529
|
+
# @return [Types::EndpointResponse]
|
2530
|
+
#
|
2531
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteEndpointResponse AWS API Documentation
|
2532
|
+
#
|
2533
|
+
class DeleteEndpointResponse < Struct.new(
|
2534
|
+
:endpoint_response)
|
2535
|
+
include Aws::Structure
|
2536
|
+
end
|
2537
|
+
|
2505
2538
|
# @note When making an API call, you may pass DeleteEventStreamRequest
|
2506
2539
|
# data as a hash:
|
2507
2540
|
#
|
@@ -2735,6 +2768,7 @@ module Aws::Pinpoint
|
|
2735
2768
|
# sms_message: {
|
2736
2769
|
# body: "__string",
|
2737
2770
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
2771
|
+
# origination_number: "__string",
|
2738
2772
|
# sender_id: "__string",
|
2739
2773
|
# substitutions: {
|
2740
2774
|
# "__string" => ["__string"],
|
@@ -5554,6 +5588,7 @@ module Aws::Pinpoint
|
|
5554
5588
|
# sms_message: {
|
5555
5589
|
# body: "__string",
|
5556
5590
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
5591
|
+
# origination_number: "__string",
|
5557
5592
|
# sender_id: "__string",
|
5558
5593
|
# substitutions: {
|
5559
5594
|
# "__string" => ["__string"],
|
@@ -5856,6 +5891,7 @@ module Aws::Pinpoint
|
|
5856
5891
|
# {
|
5857
5892
|
# body: "__string",
|
5858
5893
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
5894
|
+
# origination_number: "__string",
|
5859
5895
|
# sender_id: "__string",
|
5860
5896
|
# substitutions: {
|
5861
5897
|
# "__string" => ["__string"],
|
@@ -5871,8 +5907,17 @@ module Aws::Pinpoint
|
|
5871
5907
|
# Is this a transaction priority message or lower priority.
|
5872
5908
|
# @return [String]
|
5873
5909
|
#
|
5910
|
+
# @!attribute [rw] origination_number
|
5911
|
+
# The phone number that the SMS message originates from. Specify one
|
5912
|
+
# of the dedicated long codes or short codes that you requested from
|
5913
|
+
# AWS Support and that is assigned to your account. If this attribute
|
5914
|
+
# is not specified, Amazon Pinpoint randomly assigns a long code.
|
5915
|
+
# @return [String]
|
5916
|
+
#
|
5874
5917
|
# @!attribute [rw] sender_id
|
5875
|
-
#
|
5918
|
+
# The sender ID that is shown as the message sender on the
|
5919
|
+
# recipient's device. Support for sender IDs varies by country or
|
5920
|
+
# region.
|
5876
5921
|
# @return [String]
|
5877
5922
|
#
|
5878
5923
|
# @!attribute [rw] substitutions
|
@@ -5883,6 +5928,7 @@ module Aws::Pinpoint
|
|
5883
5928
|
class SMSMessage < Struct.new(
|
5884
5929
|
:body,
|
5885
5930
|
:message_type,
|
5931
|
+
:origination_number,
|
5886
5932
|
:sender_id,
|
5887
5933
|
:substitutions)
|
5888
5934
|
include Aws::Structure
|
@@ -6420,6 +6466,7 @@ module Aws::Pinpoint
|
|
6420
6466
|
# sms_message: {
|
6421
6467
|
# body: "__string",
|
6422
6468
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
6469
|
+
# origination_number: "__string",
|
6423
6470
|
# sender_id: "__string",
|
6424
6471
|
# substitutions: {
|
6425
6472
|
# "__string" => ["__string"],
|
@@ -6574,6 +6621,7 @@ module Aws::Pinpoint
|
|
6574
6621
|
# sms_message: {
|
6575
6622
|
# body: "__string",
|
6576
6623
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
6624
|
+
# origination_number: "__string",
|
6577
6625
|
# sender_id: "__string",
|
6578
6626
|
# substitutions: {
|
6579
6627
|
# "__string" => ["__string"],
|
@@ -6763,6 +6811,7 @@ module Aws::Pinpoint
|
|
6763
6811
|
# sms_message: {
|
6764
6812
|
# body: "__string",
|
6765
6813
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
6814
|
+
# origination_number: "__string",
|
6766
6815
|
# sender_id: "__string",
|
6767
6816
|
# substitutions: {
|
6768
6817
|
# "__string" => ["__string"],
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-pinpoint
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.4.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2018-03-
|
11
|
+
date: 2018-03-15 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|