lib/aws-sdk-customerprofiles/client.rb in aws-sdk-customerprofiles-1.15.0 vs lib/aws-sdk-customerprofiles/client.rb in aws-sdk-customerprofiles-1.16.0

- old
+ new

@@ -1104,10 +1104,11 @@ # * {Types::GetIntegrationResponse#uri #uri} => String # * {Types::GetIntegrationResponse#object_type_name #object_type_name} => String # * {Types::GetIntegrationResponse#created_at #created_at} => Time # * {Types::GetIntegrationResponse#last_updated_at #last_updated_at} => Time # * {Types::GetIntegrationResponse#tags #tags} => Hash&lt;String,String&gt; + # * {Types::GetIntegrationResponse#object_type_names #object_type_names} => Hash&lt;String,String&gt; # # @example Request syntax with placeholder values # # resp = client.get_integration({ # domain_name: "name", # required @@ -1121,23 +1122,22 @@ # resp.object_type_name #=> String # resp.created_at #=> Time # resp.last_updated_at #=> Time # resp.tags #=> Hash # resp.tags["TagKey"] #=> String + # resp.object_type_names #=> Hash + # resp.object_type_names["string1To255"] #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetIntegration AWS API Documentation # # @overload get_integration(params = {}) # @param [Hash] params ({}) def get_integration(params = {}, options = {}) req = build_request(:get_integration, params) req.send_request(options) end - # This API is in preview release for Amazon Connect and subject to - # change. - # # Before calling this API, use [CreateDomain][1] or [UpdateDomain][2] to # enable identity resolution: set `Matching` to true. # # GetMatches returns potentially matching profiles, based on the results # of the latest run of a machine learning process. @@ -1277,11 +1277,11 @@ # resp.fields["name"].target #=> String # resp.fields["name"].content_type #=> String, one of "STRING", "NUMBER", "PHONE_NUMBER", "EMAIL_ADDRESS", "NAME" # resp.keys #=> Hash # resp.keys["name"] #=> Array # resp.keys["name"][0].standard_identifiers #=> Array - # resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY" + # resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY", "ORDER" # resp.keys["name"][0].field_names #=> Array # resp.keys["name"][0].field_names[0] #=> String # resp.created_at #=> Time # resp.last_updated_at #=> Time # resp.tags #=> Hash @@ -1335,11 +1335,11 @@ # resp.fields["name"].target #=> String # resp.fields["name"].content_type #=> String, one of "STRING", "NUMBER", "PHONE_NUMBER", "EMAIL_ADDRESS", "NAME" # resp.keys #=> Hash # resp.keys["name"] #=> Array # resp.keys["name"][0].standard_identifiers #=> Array - # resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY" + # resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY", "ORDER" # resp.keys["name"][0].field_names #=> Array # resp.keys["name"][0].field_names[0] #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetProfileObjectTypeTemplate AWS API Documentation # @@ -1384,10 +1384,12 @@ # resp.items[0].object_type_name #=> String # resp.items[0].created_at #=> Time # resp.items[0].last_updated_at #=> Time # resp.items[0].tags #=> Hash # resp.items[0].tags["TagKey"] #=> String + # resp.items[0].object_type_names #=> Hash + # resp.items[0].object_type_names["string1To255"] #=> String # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListAccountIntegrations AWS API Documentation # # @overload list_account_integrations(params = {}) @@ -1521,10 +1523,12 @@ # resp.items[0].object_type_name #=> String # resp.items[0].created_at #=> Time # resp.items[0].last_updated_at #=> Time # resp.items[0].tags #=> Hash # resp.items[0].tags["TagKey"] #=> String + # resp.items[0].object_type_names #=> Hash + # resp.items[0].object_type_names["string1To255"] #=> String # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListIntegrations AWS API Documentation # # @overload list_integrations(params = {}) @@ -1635,11 +1639,11 @@ # The unique identifier of a customer profile. # # @option params [Types::ObjectFilter] :object_filter # Applies a filter to the response to include profile objects with the # specified index values. This filter is only supported for - # ObjectTypeName \_asset and \_case. + # ObjectTypeName \_asset, \_case and \_order. # # @return [Types::ListProfileObjectsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListProfileObjectsResponse#items #items} => Array&lt;Types::ListProfileObjectsItem&gt; # * {Types::ListProfileObjectsResponse#next_token #next_token} => String @@ -1704,13 +1708,10 @@ def list_tags_for_resource(params = {}, options = {}) req = build_request(:list_tags_for_resource, params) req.send_request(options) end - # This API is in preview release for Amazon Connect and subject to - # change. - # # Runs an AWS Lambda job that does the following: # # 1. All the profileKeys in the `ProfileToBeMerged` will be moved to # the main profile. # @@ -1818,35 +1819,45 @@ # The unique name of the domain. # # @option params [String] :uri # The URI of the S3 bucket or any other type of data source. # - # @option params [required, String] :object_type_name + # @option params [String] :object_type_name # The name of the profile object type. # # @option params [Hash<String,String>] :tags # The tags used to organize, track, or control access for this resource. # # @option params [Types::FlowDefinition] :flow_definition # The configuration that controls how Customer Profiles retrieves data # from the source. # + # @option params [Hash<String,String>] :object_type_names + # A map in which each key is an event type from an external application + # such as Segment or Shopify, and each value is an `ObjectTypeName` + # (template) used to ingest the event. It supports the following event + # types: `SegmentIdentify`, `ShopifyCreateCustomers`, + # `ShopifyUpdateCustomers`, `ShopifyCreateDraftOrders`, + # `ShopifyUpdateDraftOrders`, `ShopifyCreateOrders`, and + # `ShopifyUpdatedOrders`. + # # @return [Types::PutIntegrationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::PutIntegrationResponse#domain_name #domain_name} => String # * {Types::PutIntegrationResponse#uri #uri} => String # * {Types::PutIntegrationResponse#object_type_name #object_type_name} => String # * {Types::PutIntegrationResponse#created_at #created_at} => Time # * {Types::PutIntegrationResponse#last_updated_at #last_updated_at} => Time # * {Types::PutIntegrationResponse#tags #tags} => Hash&lt;String,String&gt; + # * {Types::PutIntegrationResponse#object_type_names #object_type_names} => Hash&lt;String,String&gt; # # @example Request syntax with placeholder values # # resp = client.put_integration({ # domain_name: "name", # required # uri: "string1To255", - # object_type_name: "typeName", # required + # object_type_name: "typeName", # tags: { # "TagKey" => "TagValue", # }, # flow_definition: { # description: "FlowDescription", @@ -1909,10 +1920,13 @@ # first_execution_from: Time.now, # }, # }, # }, # }, + # object_type_names: { + # "string1To255" => "typeName", + # }, # }) # # @example Response structure # # resp.domain_name #=> String @@ -1920,10 +1934,12 @@ # resp.object_type_name #=> String # resp.created_at #=> Time # resp.last_updated_at #=> Time # resp.tags #=> Hash # resp.tags["TagKey"] #=> String + # resp.object_type_names #=> Hash + # resp.object_type_names["string1To255"] #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/PutIntegration AWS API Documentation # # @overload put_integration(params = {}) # @param [Hash] params ({}) @@ -2057,11 +2073,11 @@ # }, # }, # keys: { # "name" => [ # { - # standard_identifiers: ["PROFILE"], # accepts PROFILE, ASSET, CASE, UNIQUE, SECONDARY, LOOKUP_ONLY, NEW_ONLY + # standard_identifiers: ["PROFILE"], # accepts PROFILE, ASSET, CASE, UNIQUE, SECONDARY, LOOKUP_ONLY, NEW_ONLY, ORDER # field_names: ["name"], # }, # ], # }, # tags: { @@ -2083,11 +2099,11 @@ # resp.fields["name"].target #=> String # resp.fields["name"].content_type #=> String, one of "STRING", "NUMBER", "PHONE_NUMBER", "EMAIL_ADDRESS", "NAME" # resp.keys #=> Hash # resp.keys["name"] #=> Array # resp.keys["name"][0].standard_identifiers #=> Array - # resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY" + # resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY", "ORDER" # resp.keys["name"][0].field_names #=> Array # resp.keys["name"][0].field_names[0] #=> String # resp.created_at #=> Time # resp.last_updated_at #=> Time # resp.tags #=> Hash @@ -2114,14 +2130,16 @@ # @option params [required, String] :domain_name # The unique name of the domain. # # @option params [required, String] :key_name # A searchable identifier of a customer profile. The predefined keys you - # can use to search include: \_account, \_profileId, \_fullName, - # \_phone, \_email, \_ctrContactId, \_marketoLeadId, - # \_salesforceAccountId, \_salesforceContactId, \_zendeskUserId, - # \_zendeskExternalId, \_serviceNowSystemId. + # can use to search include: \_account, \_profileId, \_assetId, + # \_caseId, \_orderId, \_fullName, \_phone, \_email, \_ctrContactId, + # \_marketoLeadId, \_salesforceAccountId, \_salesforceContactId, + # \_salesforceAssetId, \_zendeskUserId, \_zendeskExternalId, + # \_zendeskTicketId, \_serviceNowSystemId, \_serviceNowIncidentId, + # \_segmentUserId, \_shopifyCustomerId, \_shopifyOrderId. # # @option params [required, Array<String>] :values # A list of key values. # # @return [Types::SearchProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -2601,10 +2619,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-customerprofiles' - context[:gem_version] = '1.15.0' + context[:gem_version] = '1.16.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated