« blib/lib/Paws/CustomerProfiles/CreateDomainResponse.pm
↑ Summary
blib/lib/Paws/CustomerProfiles/CreateProfileResponse.pm »
| 1 | |||
| 2 | package Paws::CustomerProfiles::CreateProfile; | ||
| 3 | use Moose; | ||
| 4 | has AccountNumber => (is => 'ro', isa => 'Str'); | ||
| 5 | has AdditionalInformation => (is => 'ro', isa => 'Str'); | ||
| 6 | has Address => (is => 'ro', isa => 'Paws::CustomerProfiles::Address'); | ||
| 7 | has Attributes => (is => 'ro', isa => 'Paws::CustomerProfiles::Attributes'); | ||
| 8 | has BillingAddress => (is => 'ro', isa => 'Paws::CustomerProfiles::Address'); | ||
| 9 | has BirthDate => (is => 'ro', isa => 'Str'); | ||
| 10 | has BusinessEmailAddress => (is => 'ro', isa => 'Str'); | ||
| 11 | has BusinessName => (is => 'ro', isa => 'Str'); | ||
| 12 | has BusinessPhoneNumber => (is => 'ro', isa => 'Str'); | ||
| 13 | has DomainName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'DomainName', required => 1); | ||
| 14 | has EmailAddress => (is => 'ro', isa => 'Str'); | ||
| 15 | has FirstName => (is => 'ro', isa => 'Str'); | ||
| 16 | has Gender => (is => 'ro', isa => 'Str'); | ||
| 17 | has HomePhoneNumber => (is => 'ro', isa => 'Str'); | ||
| 18 | has LastName => (is => 'ro', isa => 'Str'); | ||
| 19 | has MailingAddress => (is => 'ro', isa => 'Paws::CustomerProfiles::Address'); | ||
| 20 | has MiddleName => (is => 'ro', isa => 'Str'); | ||
| 21 | has MobilePhoneNumber => (is => 'ro', isa => 'Str'); | ||
| 22 | has PartyType => (is => 'ro', isa => 'Str'); | ||
| 23 | has PersonalEmailAddress => (is => 'ro', isa => 'Str'); | ||
| 24 | has PhoneNumber => (is => 'ro', isa => 'Str'); | ||
| 25 | has ShippingAddress => (is => 'ro', isa => 'Paws::CustomerProfiles::Address'); | ||
| 26 | |||
| 27 | use MooseX::ClassAttribute; | ||
| 28 | |||
| 29 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateProfile'); | ||
| 30 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/domains/{DomainName}/profiles'); | ||
| 31 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 32 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CustomerProfiles::CreateProfileResponse'); | ||
| 33 | 1; | ||
| 34 | |||
| 35 | ### main pod documentation begin ### | ||
| 36 | |||
| 37 | =head1 NAME | ||
| 38 | |||
| 39 | Paws::CustomerProfiles::CreateProfile - Arguments for method CreateProfile on L<Paws::CustomerProfiles> | ||
| 40 | |||
| 41 | =head1 DESCRIPTION | ||
| 42 | |||
| 43 | This class represents the parameters used for calling the method CreateProfile on the | ||
| 44 | L<Amazon Connect Customer Profiles|Paws::CustomerProfiles> service. Use the attributes of this class | ||
| 45 | as arguments to method CreateProfile. | ||
| 46 | |||
| 47 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateProfile. | ||
| 48 | |||
| 49 | =head1 SYNOPSIS | ||
| 50 | |||
| 51 | my $profile = Paws->service('CustomerProfiles'); | ||
| 52 | my $CreateProfileResponse = $profile->CreateProfile( | ||
| 53 | DomainName => 'Myname', | ||
| 54 | AccountNumber => 'Mystring1To255', # OPTIONAL | ||
| 55 | AdditionalInformation => 'Mystring1To1000', # OPTIONAL | ||
| 56 | Address => { | ||
| 57 | Address1 => 'Mystring1To255', # min: 1, max: 255 | ||
| 58 | Address2 => 'Mystring1To255', # min: 1, max: 255 | ||
| 59 | Address3 => 'Mystring1To255', # min: 1, max: 255 | ||
| 60 | Address4 => 'Mystring1To255', # min: 1, max: 255 | ||
| 61 | City => 'Mystring1To255', # min: 1, max: 255 | ||
| 62 | Country => 'Mystring1To255', # min: 1, max: 255 | ||
| 63 | County => 'Mystring1To255', # min: 1, max: 255 | ||
| 64 | PostalCode => 'Mystring1To255', # min: 1, max: 255 | ||
| 65 | Province => 'Mystring1To255', # min: 1, max: 255 | ||
| 66 | State => 'Mystring1To255', # min: 1, max: 255 | ||
| 67 | }, # OPTIONAL | ||
| 68 | Attributes => { | ||
| 69 | 'Mystring1To255' => | ||
| 70 | 'Mystring1To255', # key: min: 1, max: 255, value: min: 1, max: 255 | ||
| 71 | }, # OPTIONAL | ||
| 72 | BillingAddress => { | ||
| 73 | Address1 => 'Mystring1To255', # min: 1, max: 255 | ||
| 74 | Address2 => 'Mystring1To255', # min: 1, max: 255 | ||
| 75 | Address3 => 'Mystring1To255', # min: 1, max: 255 | ||
| 76 | Address4 => 'Mystring1To255', # min: 1, max: 255 | ||
| 77 | City => 'Mystring1To255', # min: 1, max: 255 | ||
| 78 | Country => 'Mystring1To255', # min: 1, max: 255 | ||
| 79 | County => 'Mystring1To255', # min: 1, max: 255 | ||
| 80 | PostalCode => 'Mystring1To255', # min: 1, max: 255 | ||
| 81 | Province => 'Mystring1To255', # min: 1, max: 255 | ||
| 82 | State => 'Mystring1To255', # min: 1, max: 255 | ||
| 83 | }, # OPTIONAL | ||
| 84 | BirthDate => 'Mystring1To255', # OPTIONAL | ||
| 85 | BusinessEmailAddress => 'Mystring1To255', # OPTIONAL | ||
| 86 | BusinessName => 'Mystring1To255', # OPTIONAL | ||
| 87 | BusinessPhoneNumber => 'Mystring1To255', # OPTIONAL | ||
| 88 | EmailAddress => 'Mystring1To255', # OPTIONAL | ||
| 89 | FirstName => 'Mystring1To255', # OPTIONAL | ||
| 90 | Gender => 'MALE', # OPTIONAL | ||
| 91 | HomePhoneNumber => 'Mystring1To255', # OPTIONAL | ||
| 92 | LastName => 'Mystring1To255', # OPTIONAL | ||
| 93 | MailingAddress => { | ||
| 94 | Address1 => 'Mystring1To255', # min: 1, max: 255 | ||
| 95 | Address2 => 'Mystring1To255', # min: 1, max: 255 | ||
| 96 | Address3 => 'Mystring1To255', # min: 1, max: 255 | ||
| 97 | Address4 => 'Mystring1To255', # min: 1, max: 255 | ||
| 98 | City => 'Mystring1To255', # min: 1, max: 255 | ||
| 99 | Country => 'Mystring1To255', # min: 1, max: 255 | ||
| 100 | County => 'Mystring1To255', # min: 1, max: 255 | ||
| 101 | PostalCode => 'Mystring1To255', # min: 1, max: 255 | ||
| 102 | Province => 'Mystring1To255', # min: 1, max: 255 | ||
| 103 | State => 'Mystring1To255', # min: 1, max: 255 | ||
| 104 | }, # OPTIONAL | ||
| 105 | MiddleName => 'Mystring1To255', # OPTIONAL | ||
| 106 | MobilePhoneNumber => 'Mystring1To255', # OPTIONAL | ||
| 107 | PartyType => 'INDIVIDUAL', # OPTIONAL | ||
| 108 | PersonalEmailAddress => 'Mystring1To255', # OPTIONAL | ||
| 109 | PhoneNumber => 'Mystring1To255', # OPTIONAL | ||
| 110 | ShippingAddress => { | ||
| 111 | Address1 => 'Mystring1To255', # min: 1, max: 255 | ||
| 112 | Address2 => 'Mystring1To255', # min: 1, max: 255 | ||
| 113 | Address3 => 'Mystring1To255', # min: 1, max: 255 | ||
| 114 | Address4 => 'Mystring1To255', # min: 1, max: 255 | ||
| 115 | City => 'Mystring1To255', # min: 1, max: 255 | ||
| 116 | Country => 'Mystring1To255', # min: 1, max: 255 | ||
| 117 | County => 'Mystring1To255', # min: 1, max: 255 | ||
| 118 | PostalCode => 'Mystring1To255', # min: 1, max: 255 | ||
| 119 | Province => 'Mystring1To255', # min: 1, max: 255 | ||
| 120 | State => 'Mystring1To255', # min: 1, max: 255 | ||
| 121 | }, # OPTIONAL | ||
| 122 | ); | ||
| 123 | |||
| 124 | # Results: | ||
| 125 | my $ProfileId = $CreateProfileResponse->ProfileId; | ||
| 126 | |||
| 127 | # Returns a L<Paws::CustomerProfiles::CreateProfileResponse> object. | ||
| 128 | |||
| 129 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 130 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/profile/CreateProfile> | ||
| 131 | |||
| 132 | =head1 ATTRIBUTES | ||
| 133 | |||
| 134 | |||
| 135 | =head2 AccountNumber => Str | ||
| 136 | |||
| 137 | A unique account number that you have given to the customer. | ||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | =head2 AdditionalInformation => Str | ||
| 142 | |||
| 143 | Any additional information relevant to the customerE<rsquo>s profile. | ||
| 144 | |||
| 145 | |||
| 146 | |||
| 147 | =head2 Address => L<Paws::CustomerProfiles::Address> | ||
| 148 | |||
| 149 | A generic address associated with the customer that is not mailing, | ||
| 150 | shipping, or billing. | ||
| 151 | |||
| 152 | |||
| 153 | |||
| 154 | =head2 Attributes => L<Paws::CustomerProfiles::Attributes> | ||
| 155 | |||
| 156 | A key value pair of attributes of a customer profile. | ||
| 157 | |||
| 158 | |||
| 159 | |||
| 160 | =head2 BillingAddress => L<Paws::CustomerProfiles::Address> | ||
| 161 | |||
| 162 | The customerE<rsquo>s billing address. | ||
| 163 | |||
| 164 | |||
| 165 | |||
| 166 | =head2 BirthDate => Str | ||
| 167 | |||
| 168 | The customerE<rsquo>s birth date. | ||
| 169 | |||
| 170 | |||
| 171 | |||
| 172 | =head2 BusinessEmailAddress => Str | ||
| 173 | |||
| 174 | The customerE<rsquo>s business email address. | ||
| 175 | |||
| 176 | |||
| 177 | |||
| 178 | =head2 BusinessName => Str | ||
| 179 | |||
| 180 | The name of the customerE<rsquo>s business. | ||
| 181 | |||
| 182 | |||
| 183 | |||
| 184 | =head2 BusinessPhoneNumber => Str | ||
| 185 | |||
| 186 | The customerE<rsquo>s business phone number. | ||
| 187 | |||
| 188 | |||
| 189 | |||
| 190 | =head2 B<REQUIRED> DomainName => Str | ||
| 191 | |||
| 192 | The unique name of the domain. | ||
| 193 | |||
| 194 | |||
| 195 | |||
| 196 | =head2 EmailAddress => Str | ||
| 197 | |||
| 198 | The customerE<rsquo>s email address, which has not been specified as a | ||
| 199 | personal or business address. | ||
| 200 | |||
| 201 | |||
| 202 | |||
| 203 | =head2 FirstName => Str | ||
| 204 | |||
| 205 | The customerE<rsquo>s first name. | ||
| 206 | |||
| 207 | |||
| 208 | |||
| 209 | =head2 Gender => Str | ||
| 210 | |||
| 211 | The gender with which the customer identifies. | ||
| 212 | |||
| 213 | Valid values are: C<"MALE">, C<"FEMALE">, C<"UNSPECIFIED"> | ||
| 214 | |||
| 215 | =head2 HomePhoneNumber => Str | ||
| 216 | |||
| 217 | The customerE<rsquo>s home phone number. | ||
| 218 | |||
| 219 | |||
| 220 | |||
| 221 | =head2 LastName => Str | ||
| 222 | |||
| 223 | The customerE<rsquo>s last name. | ||
| 224 | |||
| 225 | |||
| 226 | |||
| 227 | =head2 MailingAddress => L<Paws::CustomerProfiles::Address> | ||
| 228 | |||
| 229 | The customerE<rsquo>s mailing address. | ||
| 230 | |||
| 231 | |||
| 232 | |||
| 233 | =head2 MiddleName => Str | ||
| 234 | |||
| 235 | The customerE<rsquo>s middle name. | ||
| 236 | |||
| 237 | |||
| 238 | |||
| 239 | =head2 MobilePhoneNumber => Str | ||
| 240 | |||
| 241 | The customerE<rsquo>s mobile phone number. | ||
| 242 | |||
| 243 | |||
| 244 | |||
| 245 | =head2 PartyType => Str | ||
| 246 | |||
| 247 | The type of profile used to describe the customer. | ||
| 248 | |||
| 249 | Valid values are: C<"INDIVIDUAL">, C<"BUSINESS">, C<"OTHER"> | ||
| 250 | |||
| 251 | =head2 PersonalEmailAddress => Str | ||
| 252 | |||
| 253 | The customerE<rsquo>s personal email address. | ||
| 254 | |||
| 255 | |||
| 256 | |||
| 257 | =head2 PhoneNumber => Str | ||
| 258 | |||
| 259 | The customerE<rsquo>s phone number, which has not been specified as a | ||
| 260 | mobile, home, or business number. | ||
| 261 | |||
| 262 | |||
| 263 | |||
| 264 | =head2 ShippingAddress => L<Paws::CustomerProfiles::Address> | ||
| 265 | |||
| 266 | The customerE<rsquo>s shipping address. | ||
| 267 | |||
| 268 | |||
| 269 | |||
| 270 | |||
| 271 | =head1 SEE ALSO | ||
| 272 | |||
| 273 | This class forms part of L<Paws>, documenting arguments for method CreateProfile in L<Paws::CustomerProfiles> | ||
| 274 | |||
| 275 | =head1 BUGS and CONTRIBUTIONS | ||
| 276 | |||
| 277 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 278 | |||
| 279 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 280 | |||
| 281 | =cut | ||
| 282 |