Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

ConnectCases

import { ConnectCases } from "https://aws-api.deno.dev/v0.4/services/connectcases.ts?docs=full";
class ConnectCases {
constructor(apiFactory: client.ApiFactory);
async batchGetField(params: BatchGetFieldRequest, opts?: client.RequestOptions): Promise<BatchGetFieldResponse>;
async batchPutFieldOptions(params: BatchPutFieldOptionsRequest, opts?: client.RequestOptions): Promise<BatchPutFieldOptionsResponse>;
async createCase(params: CreateCaseRequest, opts?: client.RequestOptions): Promise<CreateCaseResponse>;
async createDomain(params: CreateDomainRequest, opts?: client.RequestOptions): Promise<CreateDomainResponse>;
async createField(params: CreateFieldRequest, opts?: client.RequestOptions): Promise<CreateFieldResponse>;
async createLayout(params: CreateLayoutRequest, opts?: client.RequestOptions): Promise<CreateLayoutResponse>;
async createRelatedItem(params: CreateRelatedItemRequest, opts?: client.RequestOptions): Promise<CreateRelatedItemResponse>;
async createTemplate(params: CreateTemplateRequest, opts?: client.RequestOptions): Promise<CreateTemplateResponse>;
async deleteDomain(params: DeleteDomainRequest, opts?: client.RequestOptions): Promise<void>;
async getCase(params: GetCaseRequest, opts?: client.RequestOptions): Promise<GetCaseResponse>;
async getCaseEventConfiguration(params: GetCaseEventConfigurationRequest, opts?: client.RequestOptions): Promise<GetCaseEventConfigurationResponse>;
async getDomain(params: GetDomainRequest, opts?: client.RequestOptions): Promise<GetDomainResponse>;
async getLayout(params: GetLayoutRequest, opts?: client.RequestOptions): Promise<GetLayoutResponse>;
async getTemplate(params: GetTemplateRequest, opts?: client.RequestOptions): Promise<GetTemplateResponse>;
async listCasesForContact(params: ListCasesForContactRequest, opts?: client.RequestOptions): Promise<ListCasesForContactResponse>;
async listDomains(params?: ListDomainsRequest, opts?: client.RequestOptions): Promise<ListDomainsResponse>;
async listFieldOptions(params: ListFieldOptionsRequest, opts?: client.RequestOptions): Promise<ListFieldOptionsResponse>;
async listFields(params: ListFieldsRequest, opts?: client.RequestOptions): Promise<ListFieldsResponse>;
async listLayouts(params: ListLayoutsRequest, opts?: client.RequestOptions): Promise<ListLayoutsResponse>;
async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;
async listTemplates(params: ListTemplatesRequest, opts?: client.RequestOptions): Promise<ListTemplatesResponse>;
async putCaseEventConfiguration(params: PutCaseEventConfigurationRequest, opts?: client.RequestOptions): Promise<void>;
async searchCases(params: SearchCasesRequest, opts?: client.RequestOptions): Promise<SearchCasesResponse>;
async searchRelatedItems(params: SearchRelatedItemsRequest, opts?: client.RequestOptions): Promise<SearchRelatedItemsResponse>;
async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async updateCase(params: UpdateCaseRequest, opts?: client.RequestOptions): Promise<void>;
async updateField(params: UpdateFieldRequest, opts?: client.RequestOptions): Promise<void>;
async updateLayout(params: UpdateLayoutRequest, opts?: client.RequestOptions): Promise<void>;
async updateTemplate(params: UpdateTemplateRequest, opts?: client.RequestOptions): Promise<void>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new ConnectCases(apiFactory: client.ApiFactory)
[src]

§Methods

§

Returns the description for the list of fields in the request parameters.

§

Creates and updates a set of field options for a single select field in a Cases domain.

§

TODO: Failed to render documentation: unhandled top level doc tag pre

§

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.

! IMPORTANT: ! 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.

§

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.

§

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

Note: Title and Status fields cannot be part of layouts since they are not configurable.

§

Creates a related item (comments, tasks, and contacts) and associates it with a case.

Note: 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.

§

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.

§
deleteDomain(params: DeleteDomainRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a domain.

§
getCase(params: GetCaseRequest, opts?: client.RequestOptions): Promise<GetCaseResponse>
[src]

Returns information about a specific case if it exists.

§

Returns the case event publishing configuration.

§

Returns information about a specific domain if it exists.

§

Returns the details for the requested layout.

§

Returns the details for the requested template.

§

Lists cases for a given contact.

§
listDomains(params?: ListDomainsRequest, opts?: client.RequestOptions): Promise<ListDomainsResponse>
[src]

Lists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain.

§

Lists all of the field options for a field identifier in the domain.

§

Lists all fields in a Cases domain.

§

Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.

§

Lists tags for a resource.

§

Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template.

§
putCaseEventConfiguration(params: PutCaseEventConfigurationRequest, opts?: client.RequestOptions): Promise<void>
[src]

API for adding case event publishing configuration

§

Searches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents.

Note: 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.

§

Searches for related items that are associated with a case.

Note: If no filters are provided, this returns all related items associated with a case.

§
tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Adds tags to a resource.

§
untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Untags a resource.

§
updateCase(params: UpdateCaseRequest, opts?: client.RequestOptions): Promise<void>
[src]

Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the CreateCase input .

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

§
updateField(params: UpdateFieldRequest, opts?: client.RequestOptions): Promise<void>
[src]

Updates the properties of an existing field.

§
updateLayout(params: UpdateLayoutRequest, opts?: client.RequestOptions): Promise<void>
[src]

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.

Note: Title and Status fields cannot be part of layouts because they are not configurable.

§
updateTemplate(params: UpdateTemplateRequest, opts?: client.RequestOptions): Promise<void>
[src]

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.

§Static Properties