ConnectCases

import { ConnectCases } from "https://aws-api-bqtgftz736ft.deno.dev/v0.5/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 deleteField(params: DeleteFieldRequest, opts?: client.RequestOptions): Promise<void>;

async deleteLayout(params: DeleteLayoutRequest, opts?: client.RequestOptions): Promise<void>;

async deleteTemplate(params: DeleteTemplateRequest, opts?: client.RequestOptions): Promise<void>;

async getCase(params: GetCaseRequest, opts?: client.RequestOptions): Promise<GetCaseResponse>;

async getCaseAuditEvents(params: GetCaseAuditEventsRequest, opts?: client.RequestOptions): Promise<GetCaseAuditEventsResponse>;

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

batchGetField(params: BatchGetFieldRequest, opts?: client.RequestOptions): Promise<BatchGetFieldResponse>

[src]

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

batchPutFieldOptions(params: BatchPutFieldOptionsRequest, opts?: client.RequestOptions): Promise<BatchPutFieldOptionsResponse>

[src]

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

createCase(params: CreateCaseRequest, opts?: client.RequestOptions): Promise<CreateCaseResponse>

[src]

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

createDomain(params: CreateDomainRequest, opts?: client.RequestOptions): Promise<CreateDomainResponse>

[src]

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

createField(params: CreateFieldRequest, opts?: client.RequestOptions): Promise<CreateFieldResponse>

[src]

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.

createLayout(params: CreateLayoutRequest, opts?: client.RequestOptions): Promise<CreateLayoutResponse>

[src]

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.

createRelatedItem(params: CreateRelatedItemRequest, opts?: client.RequestOptions): Promise<CreateRelatedItemResponse>

[src]

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

createTemplate(params: CreateTemplateRequest, opts?: client.RequestOptions): Promise<CreateTemplateResponse>

[src]

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]

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

deleteField(params: DeleteFieldRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

deleteLayout(params: DeleteLayoutRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

deleteTemplate(params: DeleteTemplateRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

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

[src]

Returns information about a specific case if it exists.

getCaseAuditEvents(params: GetCaseAuditEventsRequest, opts?: client.RequestOptions): Promise<GetCaseAuditEventsResponse>

[src]

Returns the audit history about a specific case if it exists.

getCaseEventConfiguration(params: GetCaseEventConfigurationRequest, opts?: client.RequestOptions): Promise<GetCaseEventConfigurationResponse>

[src]

Returns the case event publishing configuration.

getDomain(params: GetDomainRequest, opts?: client.RequestOptions): Promise<GetDomainResponse>

[src]

Returns information about a specific domain if it exists.

getLayout(params: GetLayoutRequest, opts?: client.RequestOptions): Promise<GetLayoutResponse>

[src]

Returns the details for the requested layout.

getTemplate(params: GetTemplateRequest, opts?: client.RequestOptions): Promise<GetTemplateResponse>

[src]

Returns the details for the requested template.

listCasesForContact(params: ListCasesForContactRequest, opts?: client.RequestOptions): Promise<ListCasesForContactResponse>

[src]

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.

listFieldOptions(params: ListFieldOptionsRequest, opts?: client.RequestOptions): Promise<ListFieldOptionsResponse>

[src]

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

listFields(params: ListFieldsRequest, opts?: client.RequestOptions): Promise<ListFieldsResponse>

[src]

Lists all fields in a Cases domain.

listLayouts(params: ListLayoutsRequest, opts?: client.RequestOptions): Promise<ListLayoutsResponse>

[src]

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

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Lists tags for a resource.

listTemplates(params: ListTemplatesRequest, opts?: client.RequestOptions): Promise<ListTemplatesResponse>

[src]

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]

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

searchCases(params: SearchCasesRequest, opts?: client.RequestOptions): Promise<SearchCasesResponse>

[src]

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.

searchRelatedItems(params: SearchRelatedItemsRequest, opts?: client.RequestOptions): Promise<SearchRelatedItemsResponse>

[src]

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]

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

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

ApiMetadata: client.ApiMetadata

[src]