Class: Aws::SocialMessaging::Types::CreateWhatsAppFlowInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#categories ⇒ Array<String>

The categories that classify the business purpose of the Flow. At least one category is required.

Returns:

  • (Array<String>) 


145
146
147
148
149
150
151
152
153
154
155
 
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/types.rb', line 145

class CreateWhatsAppFlowInput < Struct.new(
  :id,
  :flow_name,
  :categories,
  :flow_json,
  :publish,
  :clone_flow_id,
  :endpoint_uri)
  SENSITIVE = []
  include Aws::Structure
end

#clone_flow_id ⇒ String

The ID of an existing Flow within the same WhatsApp Business Account to clone.

Returns:

  • (String) 


145
146
147
148
149
150
151
152
153
154
155
 
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/types.rb', line 145

class CreateWhatsAppFlowInput < Struct.new(
  :id,
  :flow_name,
  :categories,
  :flow_json,
  :publish,
  :clone_flow_id,
  :endpoint_uri)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_uri ⇒ String

Optional HTTPS endpoint for a dynamic Flow, registered with Meta as the Flow's endpoint_uri and called by Meta directly. When omitted, the Flow has no endpoint (static Flow). Meta only calls the endpoint when the Flow JSON also declares data_api_version. To verify that requests originate from Meta, attach your own Meta app via UpdateWhatsAppFlow.

Returns:

  • (String) 


145
146
147
148
149
150
151
152
153
154
155
 
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/types.rb', line 145

class CreateWhatsAppFlowInput < Struct.new(
  :id,
  :flow_name,
  :categories,
  :flow_json,
  :publish,
  :clone_flow_id,
  :endpoint_uri)
  SENSITIVE = []
  include Aws::Structure
end

#flow_json ⇒ String

The Flow JSON definition that describes the screens, components, and logic of the Flow. Maximum size is 10 MB.

Returns:

  • (String) 


145
146
147
148
149
150
151
152
153
154
155
 
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/types.rb', line 145

class CreateWhatsAppFlowInput < Struct.new(
  :id,
  :flow_name,
  :categories,
  :flow_json,
  :publish,
  :clone_flow_id,
  :endpoint_uri)
  SENSITIVE = []
  include Aws::Structure
end

#flow_name ⇒ String

The name of the Flow. Must be unique within the WhatsApp Business Account.

Returns:

  • (String) 


145
146
147
148
149
150
151
152
153
154
155
 
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/types.rb', line 145

class CreateWhatsAppFlowInput < Struct.new(
  :id,
  :flow_name,
  :categories,
  :flow_json,
  :publish,
  :clone_flow_id,
  :endpoint_uri)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The ID of the WhatsApp Business Account to associate with this Flow.

Returns:

  • (String) 


145
146
147
148
149
150
151
152
153
154
155
 
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/types.rb', line 145

class CreateWhatsAppFlowInput < Struct.new(
  :id,
  :flow_name,
  :categories,
  :flow_json,
  :publish,
  :clone_flow_id,
  :endpoint_uri)
  SENSITIVE = []
  include Aws::Structure
end

#publish ⇒ Boolean

Set to true to publish the Flow immediately after creation. Requires a valid flowJson that passes Meta's validation.

Returns:

  • (Boolean) 


145
146
147
148
149
150
151
152
153
154
155
 
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/types.rb', line 145

class CreateWhatsAppFlowInput < Struct.new(
  :id,
  :flow_name,
  :categories,
  :flow_json,
  :publish,
  :clone_flow_id,
  :endpoint_uri)
  SENSITIVE = []
  include Aws::Structure
end