Class: AttributesApi
Types.AttributesApi
Hierarchy
↳
AttributesApi
Constructors
constructor
• new AttributesApi(configuration?
)
Parameters
Name | Type | Default value |
---|---|---|
configuration | Configuration | DefaultConfig |
Inherited from
Methods
deleteAttributesBucketName
▸ deleteAttributesBucketName(requestParameters
, initOverrides?
): Promise
<APIResponseBase
>
Delete attributes from a single bucket
Parameters
Name | Type |
---|---|
requestParameters | DeleteAttributesBucketNameRequest |
initOverrides? | RequestInit | InitOverrideFunction |
Returns
deleteAttributesBucketNameRaw
▸ deleteAttributesBucketNameRaw(requestParameters
, initOverrides?
): Promise
<ApiResponse
<APIResponseBase
>>
Delete attributes from a single bucket
Parameters
Name | Type |
---|---|
requestParameters | DeleteAttributesBucketNameRequest |
initOverrides? | RequestInit | InitOverrideFunction |
Returns
Promise
<ApiResponse
<APIResponseBase
>>
getAttributes
▸ getAttributes(requestParameters?
, initOverrides?
): Promise
<GetAttributes200Response
>
Retrieve attributes from multiple buckets
Parameters
Name | Type |
---|---|
requestParameters | GetAttributesRequest |
initOverrides? | RequestInit | InitOverrideFunction |
Returns
Promise
<GetAttributes200Response
>
getAttributesBucketName
▸ getAttributesBucketName(requestParameters
, initOverrides?
): Promise
<GetAttributesBucketName200Response
>
Retrieve attributes from a single bucket
Parameters
Name | Type |
---|---|
requestParameters | GetAttributesBucketNameRequest |
initOverrides? | RequestInit | InitOverrideFunction |
Returns
Promise
<GetAttributesBucketName200Response
>
getAttributesBucketNameRaw
▸ getAttributesBucketNameRaw(requestParameters
, initOverrides?
): Promise
<ApiResponse
<GetAttributesBucketName200Response
>>
Retrieve attributes from a single bucket
Parameters
Name | Type |
---|---|
requestParameters | GetAttributesBucketNameRequest |
initOverrides? | RequestInit | InitOverrideFunction |
Returns
Promise
<ApiResponse
<GetAttributesBucketName200Response
>>
getAttributesRaw
▸ getAttributesRaw(requestParameters
, initOverrides?
): Promise
<ApiResponse
<GetAttributes200Response
>>
Retrieve attributes from multiple buckets
Parameters
Name | Type |
---|---|
requestParameters | GetAttributesRequest |
initOverrides? | RequestInit | InitOverrideFunction |
Returns
Promise
<ApiResponse
<GetAttributes200Response
>>
putAttributes
▸ putAttributes(requestParameters
, initOverrides?
): Promise
<APIResponseBase
>
Create or modify attributes in multiple buckets
Parameters
Name | Type |
---|---|
requestParameters | PutAttributesRequest |
initOverrides? | RequestInit | InitOverrideFunction |
Returns
putAttributesBucketName
▸ putAttributesBucketName(requestParameters
, initOverrides?
): Promise
<APIResponseBase
>
Create or modify attributes in a single bucket
Parameters
Name | Type |
---|---|
requestParameters | PutAttributesBucketNameRequest |
initOverrides? | RequestInit | InitOverrideFunction |
Returns
putAttributesBucketNameRaw
▸ putAttributesBucketNameRaw(requestParameters
, initOverrides?
): Promise
<ApiResponse
<APIResponseBase
>>
Create or modify attributes in a single bucket
Parameters
Name | Type |
---|---|
requestParameters | PutAttributesBucketNameRequest |
initOverrides? | RequestInit | InitOverrideFunction |
Returns
Promise
<ApiResponse
<APIResponseBase
>>
putAttributesRaw
▸ putAttributesRaw(requestParameters
, initOverrides?
): Promise
<ApiResponse
<APIResponseBase
>>
Create or modify attributes in multiple buckets
Parameters
Name | Type |
---|---|
requestParameters | PutAttributesRequest |
initOverrides? | RequestInit | InitOverrideFunction |
Returns
Promise
<ApiResponse
<APIResponseBase
>>
withMiddleware
▸ withMiddleware<T
>(this
, ...middlewares
): T
Type parameters
Name | Type |
---|---|
T | extends BaseAPI <T > |
Parameters
Name | Type |
---|---|
this | T |
...middlewares | Middleware [] |
Returns
T
Inherited from
withPostMiddleware
▸ withPostMiddleware<T
>(this
, ...postMiddlewares
): T
Type parameters
Name | Type |
---|---|
T | extends BaseAPI <T > |
Parameters
Name | Type |
---|---|
this | T |
...postMiddlewares | (undefined | (context : ResponseContext ) => Promise <void | Response >)[] |
Returns
T
Inherited from
withPreMiddleware
▸ withPreMiddleware<T
>(this
, ...preMiddlewares
): T
Type parameters
Name | Type |
---|---|
T | extends BaseAPI <T > |
Parameters
Name | Type |
---|---|
this | T |
...preMiddlewares | (undefined | (context : RequestContext ) => Promise <void | FetchParams >)[] |
Returns
T