connectcases.d.ts 71 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770
  1. import {Request} from '../lib/request';
  2. import {Response} from '../lib/response';
  3. import {AWSError} from '../lib/error';
  4. import {Service} from '../lib/service';
  5. import {ServiceConfigurationOptions} from '../lib/service';
  6. import {ConfigBase as Config} from '../lib/config-base';
  7. interface Blob {}
  8. declare class ConnectCases extends Service {
  9. /**
  10. * Constructs a service object. This object has one method for each API operation.
  11. */
  12. constructor(options?: ConnectCases.Types.ClientConfiguration)
  13. config: Config & ConnectCases.Types.ClientConfiguration;
  14. /**
  15. * Returns the description for the list of fields in the request parameters.
  16. */
  17. batchGetField(params: ConnectCases.Types.BatchGetFieldRequest, callback?: (err: AWSError, data: ConnectCases.Types.BatchGetFieldResponse) => void): Request<ConnectCases.Types.BatchGetFieldResponse, AWSError>;
  18. /**
  19. * Returns the description for the list of fields in the request parameters.
  20. */
  21. batchGetField(callback?: (err: AWSError, data: ConnectCases.Types.BatchGetFieldResponse) => void): Request<ConnectCases.Types.BatchGetFieldResponse, AWSError>;
  22. /**
  23. * Creates and updates a set of field options for a single select field in a Cases domain.
  24. */
  25. batchPutFieldOptions(params: ConnectCases.Types.BatchPutFieldOptionsRequest, callback?: (err: AWSError, data: ConnectCases.Types.BatchPutFieldOptionsResponse) => void): Request<ConnectCases.Types.BatchPutFieldOptionsResponse, AWSError>;
  26. /**
  27. * Creates and updates a set of field options for a single select field in a Cases domain.
  28. */
  29. batchPutFieldOptions(callback?: (err: AWSError, data: ConnectCases.Types.BatchPutFieldOptionsResponse) => void): Request<ConnectCases.Types.BatchPutFieldOptionsResponse, AWSError>;
  30. /**
  31. * If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide &lt;p&gt;Creates a case in the specified Cases domain. Case system and custom fields are taken as an array id/value pairs with a declared data types.&lt;/p&gt; &lt;p&gt;The following fields are required when creating a case:&lt;/p&gt; &lt;ul&gt; &lt;li&gt; &lt;p&gt; &lt;code&gt;customer_id&lt;/code&gt; - You must provide the full customer profile ARN in this format: &lt;code&gt;arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID&lt;/code&gt; &lt;/p&gt; &lt;/li&gt; &lt;li&gt; &lt;p&gt; &lt;code&gt;title&lt;/code&gt; &lt;/p&gt; &lt;/li&gt; &lt;/ul&gt;
  32. */
  33. createCase(params: ConnectCases.Types.CreateCaseRequest, callback?: (err: AWSError, data: ConnectCases.Types.CreateCaseResponse) => void): Request<ConnectCases.Types.CreateCaseResponse, AWSError>;
  34. /**
  35. * If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide &lt;p&gt;Creates a case in the specified Cases domain. Case system and custom fields are taken as an array id/value pairs with a declared data types.&lt;/p&gt; &lt;p&gt;The following fields are required when creating a case:&lt;/p&gt; &lt;ul&gt; &lt;li&gt; &lt;p&gt; &lt;code&gt;customer_id&lt;/code&gt; - You must provide the full customer profile ARN in this format: &lt;code&gt;arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID&lt;/code&gt; &lt;/p&gt; &lt;/li&gt; &lt;li&gt; &lt;p&gt; &lt;code&gt;title&lt;/code&gt; &lt;/p&gt; &lt;/li&gt; &lt;/ul&gt;
  36. */
  37. createCase(callback?: (err: AWSError, data: ConnectCases.Types.CreateCaseResponse) => void): Request<ConnectCases.Types.CreateCaseResponse, AWSError>;
  38. /**
  39. * Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts. Each Amazon Connect instance can be associated with only one Cases domain. This will not associate your connect instance to Cases domain. Instead, use the Amazon Connect CreateIntegrationAssociation API. You need specific IAM permissions to successfully associate the Cases domain. For more information, see Onboard to Cases. &lt;/important&gt;
  40. */
  41. createDomain(params: ConnectCases.Types.CreateDomainRequest, callback?: (err: AWSError, data: ConnectCases.Types.CreateDomainResponse) => void): Request<ConnectCases.Types.CreateDomainResponse, AWSError>;
  42. /**
  43. * Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts. Each Amazon Connect instance can be associated with only one Cases domain. This will not associate your connect instance to Cases domain. Instead, use the Amazon Connect CreateIntegrationAssociation API. You need specific IAM permissions to successfully associate the Cases domain. For more information, see Onboard to Cases. &lt;/important&gt;
  44. */
  45. createDomain(callback?: (err: AWSError, data: ConnectCases.Types.CreateDomainResponse) => void): Request<ConnectCases.Types.CreateDomainResponse, AWSError>;
  46. /**
  47. * Creates a field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain.
  48. */
  49. createField(params: ConnectCases.Types.CreateFieldRequest, callback?: (err: AWSError, data: ConnectCases.Types.CreateFieldResponse) => void): Request<ConnectCases.Types.CreateFieldResponse, AWSError>;
  50. /**
  51. * Creates a field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain.
  52. */
  53. createField(callback?: (err: AWSError, data: ConnectCases.Types.CreateFieldResponse) => void): Request<ConnectCases.Types.CreateFieldResponse, AWSError>;
  54. /**
  55. * Creates a layout in the Cases domain. Layouts define the following configuration in the top section and More Info tab of the Cases user interface: Fields to display to the users Field ordering Title and Status fields cannot be part of layouts since they are not configurable.
  56. */
  57. createLayout(params: ConnectCases.Types.CreateLayoutRequest, callback?: (err: AWSError, data: ConnectCases.Types.CreateLayoutResponse) => void): Request<ConnectCases.Types.CreateLayoutResponse, AWSError>;
  58. /**
  59. * Creates a layout in the Cases domain. Layouts define the following configuration in the top section and More Info tab of the Cases user interface: Fields to display to the users Field ordering Title and Status fields cannot be part of layouts since they are not configurable.
  60. */
  61. createLayout(callback?: (err: AWSError, data: ConnectCases.Types.CreateLayoutResponse) => void): Request<ConnectCases.Types.CreateLayoutResponse, AWSError>;
  62. /**
  63. * Creates a related item (comments, tasks, and contacts) and associates it with a case. A Related Item is a resource that is associated with a case. It may or may not have an external identifier linking it to an external resource (for example, a contactArn). All Related Items have their own internal identifier, the relatedItemArn. Examples of related items include comments and contacts. If you provide a value for performedBy.userArn you must also have DescribeUser permission on the ARN of the user that you provide. &lt;/note&gt;
  64. */
  65. createRelatedItem(params: ConnectCases.Types.CreateRelatedItemRequest, callback?: (err: AWSError, data: ConnectCases.Types.CreateRelatedItemResponse) => void): Request<ConnectCases.Types.CreateRelatedItemResponse, AWSError>;
  66. /**
  67. * Creates a related item (comments, tasks, and contacts) and associates it with a case. A Related Item is a resource that is associated with a case. It may or may not have an external identifier linking it to an external resource (for example, a contactArn). All Related Items have their own internal identifier, the relatedItemArn. Examples of related items include comments and contacts. If you provide a value for performedBy.userArn you must also have DescribeUser permission on the ARN of the user that you provide. &lt;/note&gt;
  68. */
  69. createRelatedItem(callback?: (err: AWSError, data: ConnectCases.Types.CreateRelatedItemResponse) => void): Request<ConnectCases.Types.CreateRelatedItemResponse, AWSError>;
  70. /**
  71. * Creates a template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.
  72. */
  73. createTemplate(params: ConnectCases.Types.CreateTemplateRequest, callback?: (err: AWSError, data: ConnectCases.Types.CreateTemplateResponse) => void): Request<ConnectCases.Types.CreateTemplateResponse, AWSError>;
  74. /**
  75. * Creates a template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.
  76. */
  77. createTemplate(callback?: (err: AWSError, data: ConnectCases.Types.CreateTemplateResponse) => void): Request<ConnectCases.Types.CreateTemplateResponse, AWSError>;
  78. /**
  79. * Deletes a Cases domain. &lt;note&gt; &lt;p&gt;After deleting your domain you must disassociate the deleted domain from your Amazon Connect instance with another API call before being able to use Cases again with this Amazon Connect instance. See &lt;a href=&quot;https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteIntegrationAssociation.html&quot;&gt;DeleteIntegrationAssociation&lt;/a&gt;.&lt;/p&gt; &lt;/note&gt;
  80. */
  81. deleteDomain(params: ConnectCases.Types.DeleteDomainRequest, callback?: (err: AWSError, data: ConnectCases.Types.DeleteDomainResponse) => void): Request<ConnectCases.Types.DeleteDomainResponse, AWSError>;
  82. /**
  83. * Deletes a Cases domain. &lt;note&gt; &lt;p&gt;After deleting your domain you must disassociate the deleted domain from your Amazon Connect instance with another API call before being able to use Cases again with this Amazon Connect instance. See &lt;a href=&quot;https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteIntegrationAssociation.html&quot;&gt;DeleteIntegrationAssociation&lt;/a&gt;.&lt;/p&gt; &lt;/note&gt;
  84. */
  85. deleteDomain(callback?: (err: AWSError, data: ConnectCases.Types.DeleteDomainResponse) => void): Request<ConnectCases.Types.DeleteDomainResponse, AWSError>;
  86. /**
  87. * Deletes a field from a cases template. You can delete up to 100 fields per domain. After a field is deleted: You can still retrieve the field by calling BatchGetField. You cannot update a deleted field by calling UpdateField; it throws a ValidationException. Deleted fields are not included in the ListFields response. Calling CreateCase with a deleted field throws a ValidationException denoting which field IDs in the request have been deleted. Calling GetCase with a deleted field ID returns the deleted field's value if one exists. Calling UpdateCase with a deleted field ID throws a ValidationException if the case does not already contain a value for the deleted field. Otherwise it succeeds, allowing you to update or remove (using emptyValue: {}) the field's value from the case. GetTemplate does not return field IDs for deleted fields. GetLayout does not return field IDs for deleted fields. Calling SearchCases with the deleted field ID as a filter returns any cases that have a value for the deleted field that matches the filter criteria. Calling SearchCases with a searchTerm value that matches a deleted field's value on a case returns the case in the response. Calling BatchPutFieldOptions with a deleted field ID throw a ValidationException. Calling GetCaseEventConfiguration does not return field IDs for deleted fields.
  88. */
  89. deleteField(params: ConnectCases.Types.DeleteFieldRequest, callback?: (err: AWSError, data: ConnectCases.Types.DeleteFieldResponse) => void): Request<ConnectCases.Types.DeleteFieldResponse, AWSError>;
  90. /**
  91. * Deletes a field from a cases template. You can delete up to 100 fields per domain. After a field is deleted: You can still retrieve the field by calling BatchGetField. You cannot update a deleted field by calling UpdateField; it throws a ValidationException. Deleted fields are not included in the ListFields response. Calling CreateCase with a deleted field throws a ValidationException denoting which field IDs in the request have been deleted. Calling GetCase with a deleted field ID returns the deleted field's value if one exists. Calling UpdateCase with a deleted field ID throws a ValidationException if the case does not already contain a value for the deleted field. Otherwise it succeeds, allowing you to update or remove (using emptyValue: {}) the field's value from the case. GetTemplate does not return field IDs for deleted fields. GetLayout does not return field IDs for deleted fields. Calling SearchCases with the deleted field ID as a filter returns any cases that have a value for the deleted field that matches the filter criteria. Calling SearchCases with a searchTerm value that matches a deleted field's value on a case returns the case in the response. Calling BatchPutFieldOptions with a deleted field ID throw a ValidationException. Calling GetCaseEventConfiguration does not return field IDs for deleted fields.
  92. */
  93. deleteField(callback?: (err: AWSError, data: ConnectCases.Types.DeleteFieldResponse) => void): Request<ConnectCases.Types.DeleteFieldResponse, AWSError>;
  94. /**
  95. * Deletes a layout from a cases template. You can delete up to 100 layouts per domain. &lt;p&gt;After a layout is deleted:&lt;/p&gt; &lt;ul&gt; &lt;li&gt; &lt;p&gt;You can still retrieve the layout by calling &lt;code&gt;GetLayout&lt;/code&gt;.&lt;/p&gt; &lt;/li&gt; &lt;li&gt; &lt;p&gt;You cannot update a deleted layout by calling &lt;code&gt;UpdateLayout&lt;/code&gt;; it throws a &lt;code&gt;ValidationException&lt;/code&gt;.&lt;/p&gt; &lt;/li&gt; &lt;li&gt; &lt;p&gt;Deleted layouts are not included in the &lt;code&gt;ListLayouts&lt;/code&gt; response.&lt;/p&gt; &lt;/li&gt; &lt;/ul&gt;
  96. */
  97. deleteLayout(params: ConnectCases.Types.DeleteLayoutRequest, callback?: (err: AWSError, data: ConnectCases.Types.DeleteLayoutResponse) => void): Request<ConnectCases.Types.DeleteLayoutResponse, AWSError>;
  98. /**
  99. * Deletes a layout from a cases template. You can delete up to 100 layouts per domain. &lt;p&gt;After a layout is deleted:&lt;/p&gt; &lt;ul&gt; &lt;li&gt; &lt;p&gt;You can still retrieve the layout by calling &lt;code&gt;GetLayout&lt;/code&gt;.&lt;/p&gt; &lt;/li&gt; &lt;li&gt; &lt;p&gt;You cannot update a deleted layout by calling &lt;code&gt;UpdateLayout&lt;/code&gt;; it throws a &lt;code&gt;ValidationException&lt;/code&gt;.&lt;/p&gt; &lt;/li&gt; &lt;li&gt; &lt;p&gt;Deleted layouts are not included in the &lt;code&gt;ListLayouts&lt;/code&gt; response.&lt;/p&gt; &lt;/li&gt; &lt;/ul&gt;
  100. */
  101. deleteLayout(callback?: (err: AWSError, data: ConnectCases.Types.DeleteLayoutResponse) => void): Request<ConnectCases.Types.DeleteLayoutResponse, AWSError>;
  102. /**
  103. * Deletes a cases template. You can delete up to 100 templates per domain. &lt;p&gt;After a cases template is deleted:&lt;/p&gt; &lt;ul&gt; &lt;li&gt; &lt;p&gt;You can still retrieve the template by calling &lt;code&gt;GetTemplate&lt;/code&gt;.&lt;/p&gt; &lt;/li&gt; &lt;li&gt; &lt;p&gt;You cannot update the template. &lt;/p&gt; &lt;/li&gt; &lt;li&gt; &lt;p&gt;You cannot create a case by using the deleted template.&lt;/p&gt; &lt;/li&gt; &lt;li&gt; &lt;p&gt;Deleted templates are not included in the &lt;code&gt;ListTemplates&lt;/code&gt; response.&lt;/p&gt; &lt;/li&gt; &lt;/ul&gt;
  104. */
  105. deleteTemplate(params: ConnectCases.Types.DeleteTemplateRequest, callback?: (err: AWSError, data: ConnectCases.Types.DeleteTemplateResponse) => void): Request<ConnectCases.Types.DeleteTemplateResponse, AWSError>;
  106. /**
  107. * Deletes a cases template. You can delete up to 100 templates per domain. &lt;p&gt;After a cases template is deleted:&lt;/p&gt; &lt;ul&gt; &lt;li&gt; &lt;p&gt;You can still retrieve the template by calling &lt;code&gt;GetTemplate&lt;/code&gt;.&lt;/p&gt; &lt;/li&gt; &lt;li&gt; &lt;p&gt;You cannot update the template. &lt;/p&gt; &lt;/li&gt; &lt;li&gt; &lt;p&gt;You cannot create a case by using the deleted template.&lt;/p&gt; &lt;/li&gt; &lt;li&gt; &lt;p&gt;Deleted templates are not included in the &lt;code&gt;ListTemplates&lt;/code&gt; response.&lt;/p&gt; &lt;/li&gt; &lt;/ul&gt;
  108. */
  109. deleteTemplate(callback?: (err: AWSError, data: ConnectCases.Types.DeleteTemplateResponse) => void): Request<ConnectCases.Types.DeleteTemplateResponse, AWSError>;
  110. /**
  111. * Returns information about a specific case if it exists.
  112. */
  113. getCase(params: ConnectCases.Types.GetCaseRequest, callback?: (err: AWSError, data: ConnectCases.Types.GetCaseResponse) => void): Request<ConnectCases.Types.GetCaseResponse, AWSError>;
  114. /**
  115. * Returns information about a specific case if it exists.
  116. */
  117. getCase(callback?: (err: AWSError, data: ConnectCases.Types.GetCaseResponse) => void): Request<ConnectCases.Types.GetCaseResponse, AWSError>;
  118. /**
  119. * Returns the audit history about a specific case if it exists.
  120. */
  121. getCaseAuditEvents(params: ConnectCases.Types.GetCaseAuditEventsRequest, callback?: (err: AWSError, data: ConnectCases.Types.GetCaseAuditEventsResponse) => void): Request<ConnectCases.Types.GetCaseAuditEventsResponse, AWSError>;
  122. /**
  123. * Returns the audit history about a specific case if it exists.
  124. */
  125. getCaseAuditEvents(callback?: (err: AWSError, data: ConnectCases.Types.GetCaseAuditEventsResponse) => void): Request<ConnectCases.Types.GetCaseAuditEventsResponse, AWSError>;
  126. /**
  127. * Returns the case event publishing configuration.
  128. */
  129. getCaseEventConfiguration(params: ConnectCases.Types.GetCaseEventConfigurationRequest, callback?: (err: AWSError, data: ConnectCases.Types.GetCaseEventConfigurationResponse) => void): Request<ConnectCases.Types.GetCaseEventConfigurationResponse, AWSError>;
  130. /**
  131. * Returns the case event publishing configuration.
  132. */
  133. getCaseEventConfiguration(callback?: (err: AWSError, data: ConnectCases.Types.GetCaseEventConfigurationResponse) => void): Request<ConnectCases.Types.GetCaseEventConfigurationResponse, AWSError>;
  134. /**
  135. * Returns information about a specific domain if it exists.
  136. */
  137. getDomain(params: ConnectCases.Types.GetDomainRequest, callback?: (err: AWSError, data: ConnectCases.Types.GetDomainResponse) => void): Request<ConnectCases.Types.GetDomainResponse, AWSError>;
  138. /**
  139. * Returns information about a specific domain if it exists.
  140. */
  141. getDomain(callback?: (err: AWSError, data: ConnectCases.Types.GetDomainResponse) => void): Request<ConnectCases.Types.GetDomainResponse, AWSError>;
  142. /**
  143. * Returns the details for the requested layout.
  144. */
  145. getLayout(params: ConnectCases.Types.GetLayoutRequest, callback?: (err: AWSError, data: ConnectCases.Types.GetLayoutResponse) => void): Request<ConnectCases.Types.GetLayoutResponse, AWSError>;
  146. /**
  147. * Returns the details for the requested layout.
  148. */
  149. getLayout(callback?: (err: AWSError, data: ConnectCases.Types.GetLayoutResponse) => void): Request<ConnectCases.Types.GetLayoutResponse, AWSError>;
  150. /**
  151. * Returns the details for the requested template.
  152. */
  153. getTemplate(params: ConnectCases.Types.GetTemplateRequest, callback?: (err: AWSError, data: ConnectCases.Types.GetTemplateResponse) => void): Request<ConnectCases.Types.GetTemplateResponse, AWSError>;
  154. /**
  155. * Returns the details for the requested template.
  156. */
  157. getTemplate(callback?: (err: AWSError, data: ConnectCases.Types.GetTemplateResponse) => void): Request<ConnectCases.Types.GetTemplateResponse, AWSError>;
  158. /**
  159. * Lists cases for a given contact.
  160. */
  161. listCasesForContact(params: ConnectCases.Types.ListCasesForContactRequest, callback?: (err: AWSError, data: ConnectCases.Types.ListCasesForContactResponse) => void): Request<ConnectCases.Types.ListCasesForContactResponse, AWSError>;
  162. /**
  163. * Lists cases for a given contact.
  164. */
  165. listCasesForContact(callback?: (err: AWSError, data: ConnectCases.Types.ListCasesForContactResponse) => void): Request<ConnectCases.Types.ListCasesForContactResponse, AWSError>;
  166. /**
  167. * Lists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain.
  168. */
  169. listDomains(params: ConnectCases.Types.ListDomainsRequest, callback?: (err: AWSError, data: ConnectCases.Types.ListDomainsResponse) => void): Request<ConnectCases.Types.ListDomainsResponse, AWSError>;
  170. /**
  171. * Lists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain.
  172. */
  173. listDomains(callback?: (err: AWSError, data: ConnectCases.Types.ListDomainsResponse) => void): Request<ConnectCases.Types.ListDomainsResponse, AWSError>;
  174. /**
  175. * Lists all of the field options for a field identifier in the domain.
  176. */
  177. listFieldOptions(params: ConnectCases.Types.ListFieldOptionsRequest, callback?: (err: AWSError, data: ConnectCases.Types.ListFieldOptionsResponse) => void): Request<ConnectCases.Types.ListFieldOptionsResponse, AWSError>;
  178. /**
  179. * Lists all of the field options for a field identifier in the domain.
  180. */
  181. listFieldOptions(callback?: (err: AWSError, data: ConnectCases.Types.ListFieldOptionsResponse) => void): Request<ConnectCases.Types.ListFieldOptionsResponse, AWSError>;
  182. /**
  183. * Lists all fields in a Cases domain.
  184. */
  185. listFields(params: ConnectCases.Types.ListFieldsRequest, callback?: (err: AWSError, data: ConnectCases.Types.ListFieldsResponse) => void): Request<ConnectCases.Types.ListFieldsResponse, AWSError>;
  186. /**
  187. * Lists all fields in a Cases domain.
  188. */
  189. listFields(callback?: (err: AWSError, data: ConnectCases.Types.ListFieldsResponse) => void): Request<ConnectCases.Types.ListFieldsResponse, AWSError>;
  190. /**
  191. * Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.
  192. */
  193. listLayouts(params: ConnectCases.Types.ListLayoutsRequest, callback?: (err: AWSError, data: ConnectCases.Types.ListLayoutsResponse) => void): Request<ConnectCases.Types.ListLayoutsResponse, AWSError>;
  194. /**
  195. * Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.
  196. */
  197. listLayouts(callback?: (err: AWSError, data: ConnectCases.Types.ListLayoutsResponse) => void): Request<ConnectCases.Types.ListLayoutsResponse, AWSError>;
  198. /**
  199. * Lists tags for a resource.
  200. */
  201. listTagsForResource(params: ConnectCases.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: ConnectCases.Types.ListTagsForResourceResponse) => void): Request<ConnectCases.Types.ListTagsForResourceResponse, AWSError>;
  202. /**
  203. * Lists tags for a resource.
  204. */
  205. listTagsForResource(callback?: (err: AWSError, data: ConnectCases.Types.ListTagsForResourceResponse) => void): Request<ConnectCases.Types.ListTagsForResourceResponse, AWSError>;
  206. /**
  207. * Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template.
  208. */
  209. listTemplates(params: ConnectCases.Types.ListTemplatesRequest, callback?: (err: AWSError, data: ConnectCases.Types.ListTemplatesResponse) => void): Request<ConnectCases.Types.ListTemplatesResponse, AWSError>;
  210. /**
  211. * Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template.
  212. */
  213. listTemplates(callback?: (err: AWSError, data: ConnectCases.Types.ListTemplatesResponse) => void): Request<ConnectCases.Types.ListTemplatesResponse, AWSError>;
  214. /**
  215. * Adds case event publishing configuration. For a complete list of fields you can add to the event message, see Create case fields in the Amazon Connect Administrator Guide
  216. */
  217. putCaseEventConfiguration(params: ConnectCases.Types.PutCaseEventConfigurationRequest, callback?: (err: AWSError, data: ConnectCases.Types.PutCaseEventConfigurationResponse) => void): Request<ConnectCases.Types.PutCaseEventConfigurationResponse, AWSError>;
  218. /**
  219. * Adds case event publishing configuration. For a complete list of fields you can add to the event message, see Create case fields in the Amazon Connect Administrator Guide
  220. */
  221. putCaseEventConfiguration(callback?: (err: AWSError, data: ConnectCases.Types.PutCaseEventConfigurationResponse) => void): Request<ConnectCases.Types.PutCaseEventConfigurationResponse, AWSError>;
  222. /**
  223. * Searches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents. For customer_id you must provide the full customer profile ARN in this format: arn:aws:profile:your AWS Region:your AWS account ID:domains/profiles domain name/profiles/profile ID.
  224. */
  225. searchCases(params: ConnectCases.Types.SearchCasesRequest, callback?: (err: AWSError, data: ConnectCases.Types.SearchCasesResponse) => void): Request<ConnectCases.Types.SearchCasesResponse, AWSError>;
  226. /**
  227. * Searches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents. For customer_id you must provide the full customer profile ARN in this format: arn:aws:profile:your AWS Region:your AWS account ID:domains/profiles domain name/profiles/profile ID.
  228. */
  229. searchCases(callback?: (err: AWSError, data: ConnectCases.Types.SearchCasesResponse) => void): Request<ConnectCases.Types.SearchCasesResponse, AWSError>;
  230. /**
  231. * Searches for related items that are associated with a case. If no filters are provided, this returns all related items associated with a case.
  232. */
  233. searchRelatedItems(params: ConnectCases.Types.SearchRelatedItemsRequest, callback?: (err: AWSError, data: ConnectCases.Types.SearchRelatedItemsResponse) => void): Request<ConnectCases.Types.SearchRelatedItemsResponse, AWSError>;
  234. /**
  235. * Searches for related items that are associated with a case. If no filters are provided, this returns all related items associated with a case.
  236. */
  237. searchRelatedItems(callback?: (err: AWSError, data: ConnectCases.Types.SearchRelatedItemsResponse) => void): Request<ConnectCases.Types.SearchRelatedItemsResponse, AWSError>;
  238. /**
  239. * Adds tags to a resource.
  240. */
  241. tagResource(params: ConnectCases.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  242. /**
  243. * Adds tags to a resource.
  244. */
  245. tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  246. /**
  247. * Untags a resource.
  248. */
  249. untagResource(params: ConnectCases.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  250. /**
  251. * Untags a resource.
  252. */
  253. untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  254. /**
  255. * If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide &lt;p&gt;Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the &lt;code&gt;CreateCase&lt;/code&gt; input .&lt;/p&gt; &lt;p&gt;If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.&lt;/p&gt;
  256. */
  257. updateCase(params: ConnectCases.Types.UpdateCaseRequest, callback?: (err: AWSError, data: ConnectCases.Types.UpdateCaseResponse) => void): Request<ConnectCases.Types.UpdateCaseResponse, AWSError>;
  258. /**
  259. * If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide &lt;p&gt;Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the &lt;code&gt;CreateCase&lt;/code&gt; input .&lt;/p&gt; &lt;p&gt;If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.&lt;/p&gt;
  260. */
  261. updateCase(callback?: (err: AWSError, data: ConnectCases.Types.UpdateCaseResponse) => void): Request<ConnectCases.Types.UpdateCaseResponse, AWSError>;
  262. /**
  263. * Updates the properties of an existing field.
  264. */
  265. updateField(params: ConnectCases.Types.UpdateFieldRequest, callback?: (err: AWSError, data: ConnectCases.Types.UpdateFieldResponse) => void): Request<ConnectCases.Types.UpdateFieldResponse, AWSError>;
  266. /**
  267. * Updates the properties of an existing field.
  268. */
  269. updateField(callback?: (err: AWSError, data: ConnectCases.Types.UpdateFieldResponse) => void): Request<ConnectCases.Types.UpdateFieldResponse, AWSError>;
  270. /**
  271. * Updates the attributes of an existing layout. If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. A ValidationException is returned when you add non-existent fieldIds to a layout. Title and Status fields cannot be part of layouts because they are not configurable.
  272. */
  273. updateLayout(params: ConnectCases.Types.UpdateLayoutRequest, callback?: (err: AWSError, data: ConnectCases.Types.UpdateLayoutResponse) => void): Request<ConnectCases.Types.UpdateLayoutResponse, AWSError>;
  274. /**
  275. * Updates the attributes of an existing layout. If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. A ValidationException is returned when you add non-existent fieldIds to a layout. Title and Status fields cannot be part of layouts because they are not configurable.
  276. */
  277. updateLayout(callback?: (err: AWSError, data: ConnectCases.Types.UpdateLayoutResponse) => void): Request<ConnectCases.Types.UpdateLayoutResponse, AWSError>;
  278. /**
  279. * Updates the attributes of an existing template. The template attributes that can be modified include name, description, layoutConfiguration, requiredFields, and status. At least one of these attributes must not be null. If a null value is provided for a given attribute, that attribute is ignored and its current value is preserved.
  280. */
  281. updateTemplate(params: ConnectCases.Types.UpdateTemplateRequest, callback?: (err: AWSError, data: ConnectCases.Types.UpdateTemplateResponse) => void): Request<ConnectCases.Types.UpdateTemplateResponse, AWSError>;
  282. /**
  283. * Updates the attributes of an existing template. The template attributes that can be modified include name, description, layoutConfiguration, requiredFields, and status. At least one of these attributes must not be null. If a null value is provided for a given attribute, that attribute is ignored and its current value is preserved.
  284. */
  285. updateTemplate(callback?: (err: AWSError, data: ConnectCases.Types.UpdateTemplateResponse) => void): Request<ConnectCases.Types.UpdateTemplateResponse, AWSError>;
  286. }
  287. declare namespace ConnectCases {
  288. export type Arn = string;
  289. export type AssociationTime = Date;
  290. export interface AuditEvent {
  291. /**
  292. * Unique identifier of a case audit history event.
  293. */
  294. eventId: AuditEventId;
  295. /**
  296. * A list of Case Audit History event fields.
  297. */
  298. fields: AuditEventFieldList;
  299. /**
  300. * Information of the user which performed the audit.
  301. */
  302. performedBy?: AuditEventPerformedBy;
  303. /**
  304. * Time at which an Audit History event took place.
  305. */
  306. performedTime: AuditEventDateTime;
  307. /**
  308. * The Type of the related item.
  309. */
  310. relatedItemType?: RelatedItemType;
  311. /**
  312. * The Type of an audit history event.
  313. */
  314. type: AuditEventType;
  315. }
  316. export type AuditEventDateTime = Date;
  317. export interface AuditEventField {
  318. /**
  319. * Unique identifier of field in an Audit History entry.
  320. */
  321. eventFieldId: AuditEventFieldId;
  322. /**
  323. * Union of potential field value types.
  324. */
  325. newValue: AuditEventFieldValueUnion;
  326. /**
  327. * Union of potential field value types.
  328. */
  329. oldValue?: AuditEventFieldValueUnion;
  330. }
  331. export type AuditEventFieldId = string;
  332. export type AuditEventFieldList = AuditEventField[];
  333. export interface AuditEventFieldValueUnion {
  334. /**
  335. * Can be either null, or have a Boolean value type. Only one value can be provided.
  336. */
  337. booleanValue?: Boolean;
  338. /**
  339. * Can be either null, or have a Double value type. Only one value can be provided.
  340. */
  341. doubleValue?: Double;
  342. emptyValue?: EmptyFieldValue;
  343. /**
  344. * Can be either null, or have a String value type. Only one value can be provided.
  345. */
  346. stringValue?: AuditEventFieldValueUnionStringValueString;
  347. /**
  348. * Can be either null, or have a String value type formatted as an ARN. Only one value can be provided.
  349. */
  350. userArnValue?: String;
  351. }
  352. export type AuditEventFieldValueUnionStringValueString = string;
  353. export type AuditEventId = string;
  354. export interface AuditEventPerformedBy {
  355. /**
  356. * Unique identifier of an IAM role.
  357. */
  358. iamPrincipalArn: IamPrincipalArn;
  359. user?: UserUnion;
  360. }
  361. export type AuditEventType = "Case.Created"|"Case.Updated"|"RelatedItem.Created"|string;
  362. export interface BasicLayout {
  363. /**
  364. * This represents sections in a tab of the page layout.
  365. */
  366. moreInfo?: LayoutSections;
  367. /**
  368. * This represents sections in a panel of the page layout.
  369. */
  370. topPanel?: LayoutSections;
  371. }
  372. export type BatchGetFieldIdentifierList = FieldIdentifier[];
  373. export interface BatchGetFieldRequest {
  374. /**
  375. * The unique identifier of the Cases domain.
  376. */
  377. domainId: DomainId;
  378. /**
  379. * A list of unique field identifiers.
  380. */
  381. fields: BatchGetFieldIdentifierList;
  382. }
  383. export interface BatchGetFieldResponse {
  384. /**
  385. * A list of field errors.
  386. */
  387. errors: BatchGetFieldResponseErrorsList;
  388. /**
  389. * A list of detailed field information.
  390. */
  391. fields: BatchGetFieldResponseFieldsList;
  392. }
  393. export type BatchGetFieldResponseErrorsList = FieldError[];
  394. export type BatchGetFieldResponseFieldsList = GetFieldResponse[];
  395. export interface BatchPutFieldOptionsRequest {
  396. /**
  397. * The unique identifier of the Cases domain.
  398. */
  399. domainId: DomainId;
  400. /**
  401. * The unique identifier of a field.
  402. */
  403. fieldId: FieldId;
  404. /**
  405. * A list of FieldOption objects.
  406. */
  407. options: BatchPutFieldOptionsRequestOptionsList;
  408. }
  409. export type BatchPutFieldOptionsRequestOptionsList = FieldOption[];
  410. export interface BatchPutFieldOptionsResponse {
  411. /**
  412. * A list of field errors.
  413. */
  414. errors?: BatchPutFieldOptionsResponseErrorsList;
  415. }
  416. export type BatchPutFieldOptionsResponseErrorsList = FieldOptionError[];
  417. export type Boolean = boolean;
  418. export type CaseArn = string;
  419. export interface CaseEventIncludedData {
  420. /**
  421. * List of field identifiers.
  422. */
  423. fields: CaseEventIncludedDataFieldsList;
  424. }
  425. export type CaseEventIncludedDataFieldsList = FieldIdentifier[];
  426. export interface CaseFilter {
  427. /**
  428. * Provides "and all" filtering.
  429. */
  430. andAll?: CaseFilterAndAllList;
  431. /**
  432. * A list of fields to filter on.
  433. */
  434. field?: FieldFilter;
  435. not?: CaseFilter;
  436. /**
  437. * Provides "or all" filtering.
  438. */
  439. orAll?: CaseFilterOrAllList;
  440. }
  441. export type CaseFilterAndAllList = CaseFilter[];
  442. export type CaseFilterOrAllList = CaseFilter[];
  443. export type CaseId = string;
  444. export interface CaseSummary {
  445. /**
  446. * A unique identifier of the case.
  447. */
  448. caseId: CaseId;
  449. /**
  450. * A unique identifier of a template.
  451. */
  452. templateId: TemplateId;
  453. }
  454. export type Channel = string;
  455. export type CommentBody = string;
  456. export type CommentBodyTextType = "Text/Plain"|string;
  457. export interface CommentContent {
  458. /**
  459. * Text in the body of a Comment on a case.
  460. */
  461. body: CommentBody;
  462. /**
  463. * Type of the text in the box of a Comment on a case.
  464. */
  465. contentType: CommentBodyTextType;
  466. }
  467. export interface CommentFilter {
  468. }
  469. export type ConnectedToSystemTime = Date;
  470. export interface Contact {
  471. /**
  472. * A unique identifier of a contact in Amazon Connect.
  473. */
  474. contactArn: ContactArn;
  475. }
  476. export type ContactArn = string;
  477. export interface ContactContent {
  478. /**
  479. * A list of channels to filter on for related items of type Contact.
  480. */
  481. channel: Channel;
  482. /**
  483. * The difference between the InitiationTimestamp and the DisconnectTimestamp of the contact.
  484. */
  485. connectedToSystemTime: ConnectedToSystemTime;
  486. /**
  487. * A unique identifier of a contact in Amazon Connect.
  488. */
  489. contactArn: ContactArn;
  490. }
  491. export interface ContactFilter {
  492. /**
  493. * A list of channels to filter on for related items of type Contact.
  494. */
  495. channel?: ContactFilterChannelList;
  496. /**
  497. * A unique identifier of a contact in Amazon Connect.
  498. */
  499. contactArn?: ContactArn;
  500. }
  501. export type ContactFilterChannelList = Channel[];
  502. export interface CreateCaseRequest {
  503. /**
  504. * A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
  505. */
  506. clientToken?: CreateCaseRequestClientTokenString;
  507. /**
  508. * The unique identifier of the Cases domain.
  509. */
  510. domainId: DomainId;
  511. /**
  512. * An array of objects with field ID (matching ListFields/DescribeField) and value union data.
  513. */
  514. fields: CreateCaseRequestFieldsList;
  515. performedBy?: UserUnion;
  516. /**
  517. * A unique identifier of a template.
  518. */
  519. templateId: TemplateId;
  520. }
  521. export type CreateCaseRequestClientTokenString = string;
  522. export type CreateCaseRequestFieldsList = FieldValue[];
  523. export interface CreateCaseResponse {
  524. /**
  525. * The Amazon Resource Name (ARN) of the case.
  526. */
  527. caseArn: CaseArn;
  528. /**
  529. * A unique identifier of the case.
  530. */
  531. caseId: CaseId;
  532. }
  533. export interface CreateDomainRequest {
  534. /**
  535. * The name for your Cases domain. It must be unique for your Amazon Web Services account.
  536. */
  537. name: DomainName;
  538. }
  539. export interface CreateDomainResponse {
  540. /**
  541. * The Amazon Resource Name (ARN) for the Cases domain.
  542. */
  543. domainArn: DomainArn;
  544. /**
  545. * The unique identifier of the Cases domain.
  546. */
  547. domainId: DomainId;
  548. /**
  549. * The status of the domain.
  550. */
  551. domainStatus: DomainStatus;
  552. }
  553. export interface CreateFieldRequest {
  554. /**
  555. * The description of the field.
  556. */
  557. description?: FieldDescription;
  558. /**
  559. * The unique identifier of the Cases domain.
  560. */
  561. domainId: DomainId;
  562. /**
  563. * The name of the field.
  564. */
  565. name: FieldName;
  566. /**
  567. * Defines the data type, some system constraints, and default display of the field.
  568. */
  569. type: FieldType;
  570. }
  571. export interface CreateFieldResponse {
  572. /**
  573. * The Amazon Resource Name (ARN) of the field.
  574. */
  575. fieldArn: FieldArn;
  576. /**
  577. * The unique identifier of a field.
  578. */
  579. fieldId: FieldId;
  580. }
  581. export interface CreateLayoutRequest {
  582. /**
  583. * Information about which fields will be present in the layout, and information about the order of the fields.
  584. */
  585. content: LayoutContent;
  586. /**
  587. * The unique identifier of the Cases domain.
  588. */
  589. domainId: DomainId;
  590. /**
  591. * The name of the layout. It must be unique for the Cases domain.
  592. */
  593. name: LayoutName;
  594. }
  595. export interface CreateLayoutResponse {
  596. /**
  597. * The Amazon Resource Name (ARN) of the newly created layout.
  598. */
  599. layoutArn: LayoutArn;
  600. /**
  601. * The unique identifier of the layout.
  602. */
  603. layoutId: LayoutId;
  604. }
  605. export interface CreateRelatedItemRequest {
  606. /**
  607. * A unique identifier of the case.
  608. */
  609. caseId: CaseId;
  610. /**
  611. * The content of a related item to be created.
  612. */
  613. content: RelatedItemInputContent;
  614. /**
  615. * The unique identifier of the Cases domain.
  616. */
  617. domainId: DomainId;
  618. /**
  619. * Represents the creator of the related item.
  620. */
  621. performedBy?: UserUnion;
  622. /**
  623. * The type of a related item.
  624. */
  625. type: RelatedItemType;
  626. }
  627. export interface CreateRelatedItemResponse {
  628. /**
  629. * The Amazon Resource Name (ARN) of the related item.
  630. */
  631. relatedItemArn: RelatedItemArn;
  632. /**
  633. * The unique identifier of the related item.
  634. */
  635. relatedItemId: RelatedItemId;
  636. }
  637. export interface CreateTemplateRequest {
  638. /**
  639. * A brief description of the template.
  640. */
  641. description?: TemplateDescription;
  642. /**
  643. * The unique identifier of the Cases domain.
  644. */
  645. domainId: DomainId;
  646. /**
  647. * Configuration of layouts associated to the template.
  648. */
  649. layoutConfiguration?: LayoutConfiguration;
  650. /**
  651. * A name for the template. It must be unique per domain.
  652. */
  653. name: TemplateName;
  654. /**
  655. * A list of fields that must contain a value for a case to be successfully created with this template.
  656. */
  657. requiredFields?: RequiredFieldList;
  658. /**
  659. * The status of the template.
  660. */
  661. status?: TemplateStatus;
  662. }
  663. export interface CreateTemplateResponse {
  664. /**
  665. * The Amazon Resource Name (ARN) of the newly created template.
  666. */
  667. templateArn: TemplateArn;
  668. /**
  669. * A unique identifier of a template.
  670. */
  671. templateId: TemplateId;
  672. }
  673. export type CreatedTime = Date;
  674. export interface DeleteDomainRequest {
  675. /**
  676. * The unique identifier of the Cases domain.
  677. */
  678. domainId: DomainId;
  679. }
  680. export interface DeleteDomainResponse {
  681. }
  682. export interface DeleteFieldRequest {
  683. /**
  684. * The unique identifier of the Cases domain.
  685. */
  686. domainId: DomainId;
  687. /**
  688. * Unique identifier of the field.
  689. */
  690. fieldId: FieldId;
  691. }
  692. export interface DeleteFieldResponse {
  693. }
  694. export interface DeleteLayoutRequest {
  695. /**
  696. * The unique identifier of the Cases domain.
  697. */
  698. domainId: DomainId;
  699. /**
  700. * The unique identifier of the layout.
  701. */
  702. layoutId: LayoutId;
  703. }
  704. export interface DeleteLayoutResponse {
  705. }
  706. export interface DeleteTemplateRequest {
  707. /**
  708. * The unique identifier of the Cases domain.
  709. */
  710. domainId: DomainId;
  711. /**
  712. * A unique identifier of a template.
  713. */
  714. templateId: TemplateId;
  715. }
  716. export interface DeleteTemplateResponse {
  717. }
  718. export type Deleted = boolean;
  719. export type DomainArn = string;
  720. export type DomainId = string;
  721. export type DomainName = string;
  722. export type DomainStatus = "Active"|"CreationInProgress"|"CreationFailed"|string;
  723. export interface DomainSummary {
  724. /**
  725. * The Amazon Resource Name (ARN) of the domain.
  726. */
  727. domainArn: DomainArn;
  728. /**
  729. * The unique identifier of the domain.
  730. */
  731. domainId: DomainId;
  732. /**
  733. * The name of the domain.
  734. */
  735. name: DomainName;
  736. }
  737. export type DomainSummaryList = DomainSummary[];
  738. export type Double = number;
  739. export interface EmptyFieldValue {
  740. }
  741. export interface EventBridgeConfiguration {
  742. /**
  743. * Indicates whether the to broadcast case event data to the customer.
  744. */
  745. enabled: Boolean;
  746. /**
  747. * Details of what case and related item data is published through the case event stream.
  748. */
  749. includedData?: EventIncludedData;
  750. }
  751. export interface EventIncludedData {
  752. /**
  753. * Details of what case data is published through the case event stream.
  754. */
  755. caseData?: CaseEventIncludedData;
  756. /**
  757. * Details of what related item data is published through the case event stream.
  758. */
  759. relatedItemData?: RelatedItemEventIncludedData;
  760. }
  761. export type FieldArn = string;
  762. export type FieldDescription = string;
  763. export interface FieldError {
  764. /**
  765. * The error code from getting a field.
  766. */
  767. errorCode: String;
  768. /**
  769. * The field identifier that caused the error.
  770. */
  771. id: FieldId;
  772. /**
  773. * The error message from getting a field.
  774. */
  775. message?: String;
  776. }
  777. export interface FieldFilter {
  778. /**
  779. * Object containing field identifier and value information.
  780. */
  781. contains?: FieldValue;
  782. /**
  783. * Object containing field identifier and value information.
  784. */
  785. equalTo?: FieldValue;
  786. /**
  787. * Object containing field identifier and value information.
  788. */
  789. greaterThan?: FieldValue;
  790. /**
  791. * Object containing field identifier and value information.
  792. */
  793. greaterThanOrEqualTo?: FieldValue;
  794. /**
  795. * Object containing field identifier and value information.
  796. */
  797. lessThan?: FieldValue;
  798. /**
  799. * Object containing field identifier and value information.
  800. */
  801. lessThanOrEqualTo?: FieldValue;
  802. }
  803. export interface FieldGroup {
  804. /**
  805. * Represents an ordered list containing field related information.
  806. */
  807. fields: FieldGroupFieldsList;
  808. /**
  809. * Name of the field group.
  810. */
  811. name?: FieldGroupNameString;
  812. }
  813. export type FieldGroupFieldsList = FieldItem[];
  814. export type FieldGroupNameString = string;
  815. export type FieldId = string;
  816. export interface FieldIdentifier {
  817. /**
  818. * Unique identifier of a field.
  819. */
  820. id: FieldId;
  821. }
  822. export interface FieldItem {
  823. /**
  824. * Unique identifier of a field.
  825. */
  826. id: FieldId;
  827. }
  828. export type FieldName = string;
  829. export type FieldNamespace = "System"|"Custom"|string;
  830. export interface FieldOption {
  831. /**
  832. * Describes whether the FieldOption is active (displayed) or inactive.
  833. */
  834. active: Boolean;
  835. /**
  836. * FieldOptionName has max length 100 and disallows trailing spaces.
  837. */
  838. name: FieldOptionName;
  839. /**
  840. * FieldOptionValue has max length 100 and must be alphanumeric with hyphens and underscores.
  841. */
  842. value: FieldOptionValue;
  843. }
  844. export interface FieldOptionError {
  845. /**
  846. * Error code from creating or updating field option.
  847. */
  848. errorCode: String;
  849. /**
  850. * Error message from creating or updating field option.
  851. */
  852. message: String;
  853. /**
  854. * The field option value that caused the error.
  855. */
  856. value: FieldOptionValue;
  857. }
  858. export type FieldOptionName = string;
  859. export type FieldOptionValue = string;
  860. export type FieldOptionsList = FieldOption[];
  861. export interface FieldSummary {
  862. /**
  863. * The Amazon Resource Name (ARN) of the field.
  864. */
  865. fieldArn: FieldArn;
  866. /**
  867. * The unique identifier of a field.
  868. */
  869. fieldId: FieldId;
  870. /**
  871. * Name of the field.
  872. */
  873. name: FieldName;
  874. /**
  875. * The namespace of a field.
  876. */
  877. namespace: FieldNamespace;
  878. /**
  879. * The type of a field.
  880. */
  881. type: FieldType;
  882. }
  883. export type FieldType = "Text"|"Number"|"Boolean"|"DateTime"|"SingleSelect"|"Url"|"User"|string;
  884. export interface FieldValue {
  885. /**
  886. * Unique identifier of a field.
  887. */
  888. id: FieldId;
  889. /**
  890. * Union of potential field value types.
  891. */
  892. value: FieldValueUnion;
  893. }
  894. export interface FieldValueUnion {
  895. /**
  896. * Can be either null, or have a Boolean value type. Only one value can be provided.
  897. */
  898. booleanValue?: Boolean;
  899. /**
  900. * Can be either null, or have a Double number value type. Only one value can be provided.
  901. */
  902. doubleValue?: Double;
  903. /**
  904. * An empty value.
  905. */
  906. emptyValue?: EmptyFieldValue;
  907. /**
  908. * String value type.
  909. */
  910. stringValue?: FieldValueUnionStringValueString;
  911. /**
  912. * Represents the user that performed the audit.
  913. */
  914. userArnValue?: String;
  915. }
  916. export type FieldValueUnionStringValueString = string;
  917. export type FileArn = string;
  918. export interface FileContent {
  919. /**
  920. * The Amazon Resource Name (ARN) of a File in Amazon Connect.
  921. */
  922. fileArn: FileArn;
  923. }
  924. export interface FileFilter {
  925. /**
  926. * The Amazon Resource Name (ARN) of the file.
  927. */
  928. fileArn?: FileArn;
  929. }
  930. export interface GetCaseAuditEventsRequest {
  931. /**
  932. * A unique identifier of the case.
  933. */
  934. caseId: CaseId;
  935. /**
  936. * The unique identifier of the Cases domain.
  937. */
  938. domainId: DomainId;
  939. /**
  940. * The maximum number of audit events to return. The current maximum supported value is 25. This is also the default when no other value is provided.
  941. */
  942. maxResults?: GetCaseAuditEventsRequestMaxResultsInteger;
  943. /**
  944. * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  945. */
  946. nextToken?: NextToken;
  947. }
  948. export type GetCaseAuditEventsRequestMaxResultsInteger = number;
  949. export interface GetCaseAuditEventsResponse {
  950. /**
  951. * A list of case audits where each represents a particular edit of the case.
  952. */
  953. auditEvents: GetCaseAuditEventsResponseAuditEventsList;
  954. /**
  955. * The token for the next set of results. This is null if there are no more results to return.
  956. */
  957. nextToken?: NextToken;
  958. }
  959. export type GetCaseAuditEventsResponseAuditEventsList = AuditEvent[];
  960. export interface GetCaseEventConfigurationRequest {
  961. /**
  962. * The unique identifier of the Cases domain.
  963. */
  964. domainId: DomainId;
  965. }
  966. export interface GetCaseEventConfigurationResponse {
  967. /**
  968. * Configuration to enable EventBridge case event delivery and determine what data is delivered.
  969. */
  970. eventBridge: EventBridgeConfiguration;
  971. }
  972. export interface GetCaseRequest {
  973. /**
  974. * A unique identifier of the case.
  975. */
  976. caseId: CaseId;
  977. /**
  978. * The unique identifier of the Cases domain.
  979. */
  980. domainId: DomainId;
  981. /**
  982. * A list of unique field identifiers.
  983. */
  984. fields: GetCaseRequestFieldsList;
  985. /**
  986. * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  987. */
  988. nextToken?: NextToken;
  989. }
  990. export type GetCaseRequestFieldsList = FieldIdentifier[];
  991. export interface GetCaseResponse {
  992. /**
  993. * A list of detailed field information.
  994. */
  995. fields: GetCaseResponseFieldsList;
  996. /**
  997. * The token for the next set of results. This is null if there are no more results to return.
  998. */
  999. nextToken?: NextToken;
  1000. /**
  1001. * A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
  1002. */
  1003. tags?: Tags;
  1004. /**
  1005. * A unique identifier of a template.
  1006. */
  1007. templateId: TemplateId;
  1008. }
  1009. export type GetCaseResponseFieldsList = FieldValue[];
  1010. export interface GetDomainRequest {
  1011. /**
  1012. * The unique identifier of the Cases domain.
  1013. */
  1014. domainId: DomainId;
  1015. }
  1016. export interface GetDomainResponse {
  1017. /**
  1018. * The timestamp when the Cases domain was created.
  1019. */
  1020. createdTime: CreatedTime;
  1021. /**
  1022. * The Amazon Resource Name (ARN) for the Cases domain.
  1023. */
  1024. domainArn: DomainArn;
  1025. /**
  1026. * The unique identifier of the Cases domain.
  1027. */
  1028. domainId: DomainId;
  1029. /**
  1030. * The status of the Cases domain.
  1031. */
  1032. domainStatus: DomainStatus;
  1033. /**
  1034. * The name of the Cases domain.
  1035. */
  1036. name: DomainName;
  1037. /**
  1038. * A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
  1039. */
  1040. tags?: Tags;
  1041. }
  1042. export interface GetFieldResponse {
  1043. /**
  1044. * Timestamp at which the resource was created.
  1045. */
  1046. createdTime?: CreatedTime;
  1047. /**
  1048. * Denotes whether or not the resource has been deleted.
  1049. */
  1050. deleted?: Deleted;
  1051. /**
  1052. * Description of the field.
  1053. */
  1054. description?: FieldDescription;
  1055. /**
  1056. * The Amazon Resource Name (ARN) of the field.
  1057. */
  1058. fieldArn: FieldArn;
  1059. /**
  1060. * Unique identifier of the field.
  1061. */
  1062. fieldId: FieldId;
  1063. /**
  1064. * Timestamp at which the resource was created or last modified.
  1065. */
  1066. lastModifiedTime?: LastModifiedTime;
  1067. /**
  1068. * Name of the field.
  1069. */
  1070. name: FieldName;
  1071. /**
  1072. * Namespace of the field.
  1073. */
  1074. namespace: FieldNamespace;
  1075. /**
  1076. * A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
  1077. */
  1078. tags?: Tags;
  1079. /**
  1080. * Type of the field.
  1081. */
  1082. type: FieldType;
  1083. }
  1084. export interface GetLayoutRequest {
  1085. /**
  1086. * The unique identifier of the Cases domain.
  1087. */
  1088. domainId: DomainId;
  1089. /**
  1090. * The unique identifier of the layout.
  1091. */
  1092. layoutId: LayoutId;
  1093. }
  1094. export interface GetLayoutResponse {
  1095. /**
  1096. * Information about which fields will be present in the layout, the order of the fields, and read-only attribute of the field.
  1097. */
  1098. content: LayoutContent;
  1099. /**
  1100. * Timestamp at which the resource was created.
  1101. */
  1102. createdTime?: CreatedTime;
  1103. /**
  1104. * Denotes whether or not the resource has been deleted.
  1105. */
  1106. deleted?: Deleted;
  1107. /**
  1108. * Timestamp at which the resource was created or last modified.
  1109. */
  1110. lastModifiedTime?: LastModifiedTime;
  1111. /**
  1112. * The Amazon Resource Name (ARN) of the newly created layout.
  1113. */
  1114. layoutArn: LayoutArn;
  1115. /**
  1116. * The unique identifier of the layout.
  1117. */
  1118. layoutId: LayoutId;
  1119. /**
  1120. * The name of the layout. It must be unique.
  1121. */
  1122. name: LayoutName;
  1123. /**
  1124. * A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
  1125. */
  1126. tags?: Tags;
  1127. }
  1128. export interface GetTemplateRequest {
  1129. /**
  1130. * The unique identifier of the Cases domain.
  1131. */
  1132. domainId: DomainId;
  1133. /**
  1134. * A unique identifier of a template.
  1135. */
  1136. templateId: TemplateId;
  1137. }
  1138. export interface GetTemplateResponse {
  1139. /**
  1140. * Timestamp at which the resource was created.
  1141. */
  1142. createdTime?: CreatedTime;
  1143. /**
  1144. * Denotes whether or not the resource has been deleted.
  1145. */
  1146. deleted?: Deleted;
  1147. /**
  1148. * A brief description of the template.
  1149. */
  1150. description?: TemplateDescription;
  1151. /**
  1152. * Timestamp at which the resource was created or last modified.
  1153. */
  1154. lastModifiedTime?: LastModifiedTime;
  1155. /**
  1156. * Configuration of layouts associated to the template.
  1157. */
  1158. layoutConfiguration?: LayoutConfiguration;
  1159. /**
  1160. * The name of the template.
  1161. */
  1162. name: TemplateName;
  1163. /**
  1164. * A list of fields that must contain a value for a case to be successfully created with this template.
  1165. */
  1166. requiredFields?: RequiredFieldList;
  1167. /**
  1168. * The status of the template.
  1169. */
  1170. status: TemplateStatus;
  1171. /**
  1172. * A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
  1173. */
  1174. tags?: Tags;
  1175. /**
  1176. * The Amazon Resource Name (ARN) of the template.
  1177. */
  1178. templateArn: TemplateArn;
  1179. /**
  1180. * A unique identifier of a template.
  1181. */
  1182. templateId: TemplateId;
  1183. }
  1184. export type IamPrincipalArn = string;
  1185. export type LastModifiedTime = Date;
  1186. export type LayoutArn = string;
  1187. export interface LayoutConfiguration {
  1188. /**
  1189. * Unique identifier of a layout.
  1190. */
  1191. defaultLayout?: LayoutId;
  1192. }
  1193. export interface LayoutContent {
  1194. /**
  1195. * Content specific to BasicLayout type. It configures fields in the top panel and More Info tab of Cases user interface.
  1196. */
  1197. basic?: BasicLayout;
  1198. }
  1199. export type LayoutId = string;
  1200. export type LayoutName = string;
  1201. export interface LayoutSections {
  1202. sections?: SectionsList;
  1203. }
  1204. export interface LayoutSummary {
  1205. /**
  1206. * The Amazon Resource Name (ARN) of the layout.
  1207. */
  1208. layoutArn: LayoutArn;
  1209. /**
  1210. * The unique identifier for of the layout.
  1211. */
  1212. layoutId: LayoutId;
  1213. /**
  1214. * The name of the layout.
  1215. */
  1216. name: LayoutName;
  1217. }
  1218. export type LayoutSummaryList = LayoutSummary[];
  1219. export interface ListCasesForContactRequest {
  1220. /**
  1221. * A unique identifier of a contact in Amazon Connect.
  1222. */
  1223. contactArn: ContactArn;
  1224. /**
  1225. * The unique identifier of the Cases domain.
  1226. */
  1227. domainId: DomainId;
  1228. /**
  1229. * The maximum number of results to return per page.
  1230. */
  1231. maxResults?: ListCasesForContactRequestMaxResultsInteger;
  1232. /**
  1233. * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  1234. */
  1235. nextToken?: NextToken;
  1236. }
  1237. export type ListCasesForContactRequestMaxResultsInteger = number;
  1238. export interface ListCasesForContactResponse {
  1239. /**
  1240. * A list of Case summary information.
  1241. */
  1242. cases: ListCasesForContactResponseCasesList;
  1243. /**
  1244. * The token for the next set of results. This is null if there are no more results to return.
  1245. */
  1246. nextToken?: NextToken;
  1247. }
  1248. export type ListCasesForContactResponseCasesList = CaseSummary[];
  1249. export interface ListDomainsRequest {
  1250. /**
  1251. * The maximum number of results to return per page.
  1252. */
  1253. maxResults?: ListDomainsRequestMaxResultsInteger;
  1254. /**
  1255. * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  1256. */
  1257. nextToken?: NextToken;
  1258. }
  1259. export type ListDomainsRequestMaxResultsInteger = number;
  1260. export interface ListDomainsResponse {
  1261. /**
  1262. * The Cases domain.
  1263. */
  1264. domains: DomainSummaryList;
  1265. /**
  1266. * The token for the next set of results. This is null if there are no more results to return.
  1267. */
  1268. nextToken?: NextToken;
  1269. }
  1270. export interface ListFieldOptionsRequest {
  1271. /**
  1272. * The unique identifier of the Cases domain.
  1273. */
  1274. domainId: DomainId;
  1275. /**
  1276. * The unique identifier of a field.
  1277. */
  1278. fieldId: FieldId;
  1279. /**
  1280. * The maximum number of results to return per page.
  1281. */
  1282. maxResults?: MaxResults;
  1283. /**
  1284. * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  1285. */
  1286. nextToken?: NextToken;
  1287. /**
  1288. * A list of FieldOption values to filter on for ListFieldOptions.
  1289. */
  1290. values?: ValuesList;
  1291. }
  1292. export interface ListFieldOptionsResponse {
  1293. /**
  1294. * The token for the next set of results. This is null if there are no more results to return.
  1295. */
  1296. nextToken?: NextToken;
  1297. /**
  1298. * A list of FieldOption objects.
  1299. */
  1300. options: FieldOptionsList;
  1301. }
  1302. export interface ListFieldsRequest {
  1303. /**
  1304. * The unique identifier of the Cases domain.
  1305. */
  1306. domainId: DomainId;
  1307. /**
  1308. * The maximum number of results to return per page.
  1309. */
  1310. maxResults?: MaxResults;
  1311. /**
  1312. * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  1313. */
  1314. nextToken?: NextToken;
  1315. }
  1316. export interface ListFieldsResponse {
  1317. /**
  1318. * List of detailed field information.
  1319. */
  1320. fields: ListFieldsResponseFieldsList;
  1321. /**
  1322. * The token for the next set of results. This is null if there are no more results to return.
  1323. */
  1324. nextToken?: NextToken;
  1325. }
  1326. export type ListFieldsResponseFieldsList = FieldSummary[];
  1327. export interface ListLayoutsRequest {
  1328. /**
  1329. * The unique identifier of the Cases domain.
  1330. */
  1331. domainId: DomainId;
  1332. /**
  1333. * The maximum number of results to return per page.
  1334. */
  1335. maxResults?: MaxResults;
  1336. /**
  1337. * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  1338. */
  1339. nextToken?: NextToken;
  1340. }
  1341. export interface ListLayoutsResponse {
  1342. /**
  1343. * The layouts for the domain.
  1344. */
  1345. layouts: LayoutSummaryList;
  1346. /**
  1347. * The token for the next set of results. This is null if there are no more results to return.
  1348. */
  1349. nextToken?: NextToken;
  1350. }
  1351. export interface ListTagsForResourceRequest {
  1352. /**
  1353. * The Amazon Resource Name (ARN)
  1354. */
  1355. arn: Arn;
  1356. }
  1357. export interface ListTagsForResourceResponse {
  1358. /**
  1359. * A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
  1360. */
  1361. tags?: Tags;
  1362. }
  1363. export interface ListTemplatesRequest {
  1364. /**
  1365. * The unique identifier of the Cases domain.
  1366. */
  1367. domainId: DomainId;
  1368. /**
  1369. * The maximum number of results to return per page.
  1370. */
  1371. maxResults?: MaxResults;
  1372. /**
  1373. * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  1374. */
  1375. nextToken?: NextToken;
  1376. /**
  1377. * A list of status values to filter on.
  1378. */
  1379. status?: TemplateStatusFilters;
  1380. }
  1381. export interface ListTemplatesResponse {
  1382. /**
  1383. * The token for the next set of results. This is null if there are no more results to return.
  1384. */
  1385. nextToken?: NextToken;
  1386. /**
  1387. * List of template summary objects.
  1388. */
  1389. templates: ListTemplatesResponseTemplatesList;
  1390. }
  1391. export type ListTemplatesResponseTemplatesList = TemplateSummary[];
  1392. export type MaxResults = number;
  1393. export type NextToken = string;
  1394. export type Order = "Asc"|"Desc"|string;
  1395. export interface PutCaseEventConfigurationRequest {
  1396. /**
  1397. * The unique identifier of the Cases domain.
  1398. */
  1399. domainId: DomainId;
  1400. /**
  1401. * Configuration to enable EventBridge case event delivery and determine what data is delivered.
  1402. */
  1403. eventBridge: EventBridgeConfiguration;
  1404. }
  1405. export interface PutCaseEventConfigurationResponse {
  1406. }
  1407. export type RelatedItemArn = string;
  1408. export interface RelatedItemContent {
  1409. /**
  1410. * Represents the content of a comment to be returned to agents.
  1411. */
  1412. comment?: CommentContent;
  1413. /**
  1414. * Represents the content of a contact to be returned to agents.
  1415. */
  1416. contact?: ContactContent;
  1417. /**
  1418. * Represents the content of a File to be returned to agents.
  1419. */
  1420. file?: FileContent;
  1421. }
  1422. export interface RelatedItemEventIncludedData {
  1423. /**
  1424. * Details of what related item data is published through the case event stream.
  1425. */
  1426. includeContent: Boolean;
  1427. }
  1428. export type RelatedItemId = string;
  1429. export interface RelatedItemInputContent {
  1430. /**
  1431. * Represents the content of a comment to be returned to agents.
  1432. */
  1433. comment?: CommentContent;
  1434. /**
  1435. * Object representing a contact in Amazon Connect as an API request field.
  1436. */
  1437. contact?: Contact;
  1438. /**
  1439. * A file of related items.
  1440. */
  1441. file?: FileContent;
  1442. }
  1443. export type RelatedItemType = "Contact"|"Comment"|"File"|string;
  1444. export interface RelatedItemTypeFilter {
  1445. /**
  1446. * A filter for related items of type Comment.
  1447. */
  1448. comment?: CommentFilter;
  1449. /**
  1450. * A filter for related items of type Contact.
  1451. */
  1452. contact?: ContactFilter;
  1453. /**
  1454. * A filter for related items of this type of File.
  1455. */
  1456. file?: FileFilter;
  1457. }
  1458. export interface RequiredField {
  1459. /**
  1460. * Unique identifier of a field.
  1461. */
  1462. fieldId: FieldId;
  1463. }
  1464. export type RequiredFieldList = RequiredField[];
  1465. export interface SearchCasesRequest {
  1466. /**
  1467. * The unique identifier of the Cases domain.
  1468. */
  1469. domainId: DomainId;
  1470. /**
  1471. * The list of field identifiers to be returned as part of the response.
  1472. */
  1473. fields?: SearchCasesRequestFieldsList;
  1474. /**
  1475. * A list of filter objects.
  1476. */
  1477. filter?: CaseFilter;
  1478. /**
  1479. * The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.
  1480. */
  1481. maxResults?: SearchCasesRequestMaxResultsInteger;
  1482. /**
  1483. * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  1484. */
  1485. nextToken?: NextToken;
  1486. /**
  1487. * A word or phrase used to perform a quick search.
  1488. */
  1489. searchTerm?: SearchCasesRequestSearchTermString;
  1490. /**
  1491. * A list of sorts where each sort specifies a field and their sort order to be applied to the results.
  1492. */
  1493. sorts?: SearchCasesRequestSortsList;
  1494. }
  1495. export type SearchCasesRequestFieldsList = FieldIdentifier[];
  1496. export type SearchCasesRequestMaxResultsInteger = number;
  1497. export type SearchCasesRequestSearchTermString = string;
  1498. export type SearchCasesRequestSortsList = Sort[];
  1499. export interface SearchCasesResponse {
  1500. /**
  1501. * A list of case documents where each case contains the properties CaseId and Fields where each field is a complex union structure.
  1502. */
  1503. cases: SearchCasesResponseCasesList;
  1504. /**
  1505. * The token for the next set of results. This is null if there are no more results to return.
  1506. */
  1507. nextToken?: NextToken;
  1508. }
  1509. export type SearchCasesResponseCasesList = SearchCasesResponseItem[];
  1510. export interface SearchCasesResponseItem {
  1511. /**
  1512. * A unique identifier of the case.
  1513. */
  1514. caseId: CaseId;
  1515. /**
  1516. * List of case field values.
  1517. */
  1518. fields: SearchCasesResponseItemFieldsList;
  1519. /**
  1520. * A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
  1521. */
  1522. tags?: Tags;
  1523. /**
  1524. * A unique identifier of a template.
  1525. */
  1526. templateId: TemplateId;
  1527. }
  1528. export type SearchCasesResponseItemFieldsList = FieldValue[];
  1529. export interface SearchRelatedItemsRequest {
  1530. /**
  1531. * A unique identifier of the case.
  1532. */
  1533. caseId: CaseId;
  1534. /**
  1535. * The unique identifier of the Cases domain.
  1536. */
  1537. domainId: DomainId;
  1538. /**
  1539. * The list of types of related items and their parameters to use for filtering.
  1540. */
  1541. filters?: SearchRelatedItemsRequestFiltersList;
  1542. /**
  1543. * The maximum number of results to return per page.
  1544. */
  1545. maxResults?: SearchRelatedItemsRequestMaxResultsInteger;
  1546. /**
  1547. * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  1548. */
  1549. nextToken?: NextToken;
  1550. }
  1551. export type SearchRelatedItemsRequestFiltersList = RelatedItemTypeFilter[];
  1552. export type SearchRelatedItemsRequestMaxResultsInteger = number;
  1553. export interface SearchRelatedItemsResponse {
  1554. /**
  1555. * The token for the next set of results. This is null if there are no more results to return.
  1556. */
  1557. nextToken?: NextToken;
  1558. /**
  1559. * A list of items related to a case.
  1560. */
  1561. relatedItems: SearchRelatedItemsResponseRelatedItemsList;
  1562. }
  1563. export interface SearchRelatedItemsResponseItem {
  1564. /**
  1565. * Time at which a related item was associated with a case.
  1566. */
  1567. associationTime: AssociationTime;
  1568. /**
  1569. * Represents the content of a particular type of related item.
  1570. */
  1571. content: RelatedItemContent;
  1572. /**
  1573. * Represents the creator of the related item.
  1574. */
  1575. performedBy?: UserUnion;
  1576. /**
  1577. * Unique identifier of a related item.
  1578. */
  1579. relatedItemId: RelatedItemId;
  1580. /**
  1581. * A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
  1582. */
  1583. tags?: Tags;
  1584. /**
  1585. * Type of a related item.
  1586. */
  1587. type: RelatedItemType;
  1588. }
  1589. export type SearchRelatedItemsResponseRelatedItemsList = SearchRelatedItemsResponseItem[];
  1590. export interface Section {
  1591. /**
  1592. * Consists of a group of fields and associated properties.
  1593. */
  1594. fieldGroup?: FieldGroup;
  1595. }
  1596. export type SectionsList = Section[];
  1597. export interface Sort {
  1598. /**
  1599. * Unique identifier of a field.
  1600. */
  1601. fieldId: FieldId;
  1602. /**
  1603. * A structured set of sort terms
  1604. */
  1605. sortOrder: Order;
  1606. }
  1607. export type String = string;
  1608. export type TagKey = string;
  1609. export type TagKeyList = TagKey[];
  1610. export interface TagResourceRequest {
  1611. /**
  1612. * The Amazon Resource Name (ARN)
  1613. */
  1614. arn: Arn;
  1615. /**
  1616. * A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
  1617. */
  1618. tags: Tags;
  1619. }
  1620. export type Tags = {[key: string]: String};
  1621. export type TemplateArn = string;
  1622. export type TemplateDescription = string;
  1623. export type TemplateId = string;
  1624. export type TemplateName = string;
  1625. export type TemplateStatus = "Active"|"Inactive"|string;
  1626. export type TemplateStatusFilters = TemplateStatus[];
  1627. export interface TemplateSummary {
  1628. /**
  1629. * The template name.
  1630. */
  1631. name: TemplateName;
  1632. /**
  1633. * The status of the template.
  1634. */
  1635. status: TemplateStatus;
  1636. /**
  1637. * The Amazon Resource Name (ARN) of the template.
  1638. */
  1639. templateArn: TemplateArn;
  1640. /**
  1641. * The unique identifier for the template.
  1642. */
  1643. templateId: TemplateId;
  1644. }
  1645. export interface UntagResourceRequest {
  1646. /**
  1647. * The Amazon Resource Name (ARN)
  1648. */
  1649. arn: Arn;
  1650. /**
  1651. * List of tag keys.
  1652. */
  1653. tagKeys: TagKeyList;
  1654. }
  1655. export interface UpdateCaseRequest {
  1656. /**
  1657. * A unique identifier of the case.
  1658. */
  1659. caseId: CaseId;
  1660. /**
  1661. * The unique identifier of the Cases domain.
  1662. */
  1663. domainId: DomainId;
  1664. /**
  1665. * An array of objects with fieldId (matching ListFields/DescribeField) and value union data, structured identical to CreateCase.
  1666. */
  1667. fields: UpdateCaseRequestFieldsList;
  1668. performedBy?: UserUnion;
  1669. }
  1670. export type UpdateCaseRequestFieldsList = FieldValue[];
  1671. export interface UpdateCaseResponse {
  1672. }
  1673. export interface UpdateFieldRequest {
  1674. /**
  1675. * The description of a field.
  1676. */
  1677. description?: FieldDescription;
  1678. /**
  1679. * The unique identifier of the Cases domain.
  1680. */
  1681. domainId: DomainId;
  1682. /**
  1683. * The unique identifier of a field.
  1684. */
  1685. fieldId: FieldId;
  1686. /**
  1687. * The name of the field.
  1688. */
  1689. name?: FieldName;
  1690. }
  1691. export interface UpdateFieldResponse {
  1692. }
  1693. export interface UpdateLayoutRequest {
  1694. /**
  1695. * Information about which fields will be present in the layout, the order of the fields.
  1696. */
  1697. content?: LayoutContent;
  1698. /**
  1699. * The unique identifier of the Cases domain.
  1700. */
  1701. domainId: DomainId;
  1702. /**
  1703. * The unique identifier of the layout.
  1704. */
  1705. layoutId: LayoutId;
  1706. /**
  1707. * The name of the layout. It must be unique per domain.
  1708. */
  1709. name?: LayoutName;
  1710. }
  1711. export interface UpdateLayoutResponse {
  1712. }
  1713. export interface UpdateTemplateRequest {
  1714. /**
  1715. * A brief description of the template.
  1716. */
  1717. description?: TemplateDescription;
  1718. /**
  1719. * The unique identifier of the Cases domain.
  1720. */
  1721. domainId: DomainId;
  1722. /**
  1723. * Configuration of layouts associated to the template.
  1724. */
  1725. layoutConfiguration?: LayoutConfiguration;
  1726. /**
  1727. * The name of the template. It must be unique per domain.
  1728. */
  1729. name?: TemplateName;
  1730. /**
  1731. * A list of fields that must contain a value for a case to be successfully created with this template.
  1732. */
  1733. requiredFields?: RequiredFieldList;
  1734. /**
  1735. * The status of the template.
  1736. */
  1737. status?: TemplateStatus;
  1738. /**
  1739. * A unique identifier for the template.
  1740. */
  1741. templateId: TemplateId;
  1742. }
  1743. export interface UpdateTemplateResponse {
  1744. }
  1745. export type UserArn = string;
  1746. export interface UserUnion {
  1747. /**
  1748. * Represents the Amazon Connect ARN of the user.
  1749. */
  1750. userArn?: UserArn;
  1751. }
  1752. export type Value = string;
  1753. export type ValuesList = Value[];
  1754. /**
  1755. * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
  1756. */
  1757. export type apiVersion = "2022-10-03"|"latest"|string;
  1758. export interface ClientApiVersions {
  1759. /**
  1760. * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
  1761. */
  1762. apiVersion?: apiVersion;
  1763. }
  1764. export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
  1765. /**
  1766. * Contains interfaces for use with the ConnectCases client.
  1767. */
  1768. export import Types = ConnectCases;
  1769. }
  1770. export = ConnectCases;