News

SDK Reference · Resource

News

Read product and service announcements.

list()

method

list()

List product announcements

Returns the latest customer-facing service announcements and product updates, ordered from newest to oldest.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.news.list(options: NewsListOptions = {}): Promise<NewsListResponse>

Parameters

Name	Type	Requirement	Description
limit	number	Optional	Number of results to return per page.
offset	number	Optional	The initial index from which to return the results.
ordering	string	Optional	Which field to use when ordering the results.
search	string	Optional	Case-insensitive partial search across News fields: `title` and `content`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.news.list();

Returns

PaginatedNewsList

The operation completed successfully.

typePaginatedNewsList4fields

FieldTypeRequirementDescription

count

number

Required

—

next

string

Optional

—

previous

string

Optional

—

results

News[]

Required

—

typeNews4fields

FieldTypeRequirementDescription

id

string

Optional

—

title

string

Required

—

content

string

Required

The content of the news item. HTML is allowed.

date

string

Optional

The date and time when the news item is published.

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.news.listWithResponse(options): Promise<ApiResponse<NewsListResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.news.list(*, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, search: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedNewsList

Asyncawait async_client.news.list(*, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, search: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedNewsList

Parameters

Name	Type	Requirement	Description
limit	int	Optional	Number of results to return per page.
offset	int	Optional	The initial index from which to return the results.
ordering	str	Optional	Which field to use when ordering the results.
search	str	Optional	Case-insensitive partial search across News fields: `title` and `content`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.news.list()

Async example

result = await async_client.news.list()

Returns

PaginatedNewsList

The operation completed successfully.

classPaginatedNewsList4fields

FieldTypeRequirementDescription

count

int

Required

—

results

list[News]

Required

—

classNews4fields

FieldTypeRequirementDescription

title

str

Required

—

content

str

Required

The content of the news item. HTML is allowed.

id

str

Optional

—

date

datetime.datetime

Optional

The date and time when the news item is published.

next_

None | str

Optional

—

previous

None | str

Optional

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.news.list_with_response(*, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, search: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[PaginatedNewsList]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->news()->list($limit = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

Parameters

Name	Type	Requirement	Description
limit	int	Optional	Number of results to return per page.
offset	int	Optional	The initial index from which to return the results.
ordering	string	Optional	Which field to use when ordering the results.
search	string	Optional	Case-insensitive partial search across News fields: `title` and `content`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->news()->list();

Returns

PaginatedNewsList

The operation completed successfully.

classPaginatedNewsList4fields

FieldTypeRequirementDescription

count

int

Required

|

next

string

Required

| [optional]

previous

string

Required

| [optional]

results

[News[]](News.md)

Required

|

classNews4fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

title

string

Required

|

content

string

Required

The content of the news item. HTML is allowed. |

date

DateTime

Optional

The date and time when the news item is published.

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->news()->listWithResponse($limit = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->news()->listWithHttpInfo($limit = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Returns the OpenAPI Generator response tuple.

• $client->news()->listAsync($limit = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Returns a Guzzle promise for the decoded result.

• $client->news()->listAsyncWithHttpInfo($limit = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Returns a Guzzle promise for the response tuple.

• $client->news()->listRequest($limit = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Builds the PSR-7 request without sending it.