From 4f5b6c9aca4412d9cc20ba6a0a68076756a316f3 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 4 Dec 2024 01:28:15 +0000 Subject: [PATCH] feat(kv)!: move analytics under existing namespace (#2212) --- api.md | 26 +++++++++---------- src/index.ts | 5 ---- src/resources/index.ts | 1 - .../{storage => kv/namespaces}/analytics.ts | 4 +-- src/resources/kv/namespaces/index.ts | 7 +++++ src/resources/kv/namespaces/namespaces.ts | 12 +++++++++ src/resources/storage/index.ts | 10 ------- src/resources/storage/storage.ts | 21 --------------- .../namespaces}/analytics.test.ts | 10 ++++--- 9 files changed, 39 insertions(+), 57 deletions(-) rename src/resources/{storage => kv/namespaces}/analytics.ts (99%) delete mode 100644 src/resources/storage/index.ts delete mode 100644 src/resources/storage/storage.ts rename tests/api-resources/{storage => kv/namespaces}/analytics.test.ts (86%) diff --git a/api.md b/api.md index 1a73bfa64fc..1ddbaac5b5a 100644 --- a/api.md +++ b/api.md @@ -2202,6 +2202,18 @@ Methods: - client.kv.namespaces.bulkUpdate(namespaceId, [ ...body ]) -> NamespaceBulkUpdateResponse | null - client.kv.namespaces.get(namespaceId, { ...params }) -> Namespace +### Analytics + +Types: + +- Components +- Schema + +Methods: + +- client.kv.namespaces.analytics.list({ ...params }) -> Schema +- client.kv.namespaces.analytics.stored({ ...params }) -> Components + ### Keys Types: @@ -3645,20 +3657,6 @@ Methods: - client.rules.lists.items.delete(listId, { ...params }) -> ItemDeleteResponse - client.rules.lists.items.get(accountIdentifier, listId, itemId) -> ItemGetResponse -# Storage - -## Analytics - -Types: - -- Components -- Schema - -Methods: - -- client.storage.analytics.list({ ...params }) -> Schema -- client.storage.analytics.stored({ ...params }) -> Components - # Stream Types: diff --git a/src/index.ts b/src/index.ts index ce022a7f66b..6b584b70fec 100644 --- a/src/index.ts +++ b/src/index.ts @@ -95,7 +95,6 @@ import { Snippets } from './resources/snippets/snippets'; import { Spectrum } from './resources/spectrum/spectrum'; import { Speed } from './resources/speed/speed'; import { SSL } from './resources/ssl/ssl'; -import { Storage } from './resources/storage/storage'; import { Stream } from './resources/stream/stream'; import { Turnstile } from './resources/turnstile/turnstile'; import { URLScanner } from './resources/url-scanner/url-scanner'; @@ -301,7 +300,6 @@ export class Cloudflare extends Core.APIClient { registrar: API.Registrar = new API.Registrar(this); requestTracers: API.RequestTracers = new API.RequestTracers(this); rules: API.Rules = new API.Rules(this); - storage: API.Storage = new API.Storage(this); stream: API.Stream = new API.Stream(this); alerting: API.Alerting = new API.Alerting(this); d1: API.D1Resource = new API.D1Resource(this); @@ -511,7 +509,6 @@ Cloudflare.Pages = Pages; Cloudflare.Registrar = Registrar; Cloudflare.RequestTracers = RequestTracers; Cloudflare.Rules = Rules; -Cloudflare.Storage = Storage; Cloudflare.Stream = Stream; Cloudflare.Alerting = Alerting; Cloudflare.D1Resource = D1Resource; @@ -680,8 +677,6 @@ export declare namespace Cloudflare { export { Rules as Rules }; - export { Storage as Storage }; - export { Stream as Stream }; export { Alerting as Alerting }; diff --git a/src/resources/index.ts b/src/resources/index.ts index 27fda7d8f2a..7914ef19f33 100644 --- a/src/resources/index.ts +++ b/src/resources/index.ts @@ -76,7 +76,6 @@ export { SecurityTXT } from './security-txt'; export { Snippets } from './snippets/snippets'; export { Spectrum } from './spectrum/spectrum'; export { Speed } from './speed/speed'; -export { Storage } from './storage/storage'; export { Stream } from './stream/stream'; export { Turnstile } from './turnstile/turnstile'; export { URLNormalization } from './url-normalization'; diff --git a/src/resources/storage/analytics.ts b/src/resources/kv/namespaces/analytics.ts similarity index 99% rename from src/resources/storage/analytics.ts rename to src/resources/kv/namespaces/analytics.ts index 909340a1854..d996fc4ccbf 100644 --- a/src/resources/storage/analytics.ts +++ b/src/resources/kv/namespaces/analytics.ts @@ -1,7 +1,7 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -import { APIResource } from '../../resource'; -import * as Core from '../../core'; +import { APIResource } from '../../../resource'; +import * as Core from '../../../core'; export class Analytics extends APIResource { /** diff --git a/src/resources/kv/namespaces/index.ts b/src/resources/kv/namespaces/index.ts index 7cfcd366ef0..1dc1c6409a8 100644 --- a/src/resources/kv/namespaces/index.ts +++ b/src/resources/kv/namespaces/index.ts @@ -1,5 +1,12 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. +export { + Analytics, + type Components, + type Schema, + type AnalyticsListParams, + type AnalyticsStoredParams, +} from './analytics'; export { KeysCursorLimitPagination, Keys, type Key, type KeyListParams } from './keys'; export { Metadata, type MetadataGetResponse, type MetadataGetParams } from './metadata'; export { diff --git a/src/resources/kv/namespaces/namespaces.ts b/src/resources/kv/namespaces/namespaces.ts index 047c34cfb53..0f4eb36444a 100644 --- a/src/resources/kv/namespaces/namespaces.ts +++ b/src/resources/kv/namespaces/namespaces.ts @@ -2,6 +2,8 @@ import { APIResource } from '../../../resource'; import * as Core from '../../../core'; +import * as AnalyticsAPI from './analytics'; +import { Analytics, AnalyticsListParams, AnalyticsStoredParams, Components, Schema } from './analytics'; import * as KeysAPI from './keys'; import { Key, KeyListParams, Keys, KeysCursorLimitPagination } from './keys'; import * as MetadataAPI from './metadata'; @@ -18,6 +20,7 @@ import { import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../../pagination'; export class Namespaces extends APIResource { + analytics: AnalyticsAPI.Analytics = new AnalyticsAPI.Analytics(this._client); keys: KeysAPI.Keys = new KeysAPI.Keys(this._client); metadata: MetadataAPI.Metadata = new MetadataAPI.Metadata(this._client); values: ValuesAPI.Values = new ValuesAPI.Values(this._client); @@ -311,6 +314,7 @@ export interface NamespaceGetParams { } Namespaces.NamespacesV4PagePaginationArray = NamespacesV4PagePaginationArray; +Namespaces.Analytics = Analytics; Namespaces.Keys = Keys; Namespaces.KeysCursorLimitPagination = KeysCursorLimitPagination; Namespaces.Metadata = Metadata; @@ -333,6 +337,14 @@ export declare namespace Namespaces { type NamespaceGetParams as NamespaceGetParams, }; + export { + Analytics as Analytics, + type Components as Components, + type Schema as Schema, + type AnalyticsListParams as AnalyticsListParams, + type AnalyticsStoredParams as AnalyticsStoredParams, + }; + export { Keys as Keys, type Key as Key, diff --git a/src/resources/storage/index.ts b/src/resources/storage/index.ts deleted file mode 100644 index 95ed8d77f48..00000000000 --- a/src/resources/storage/index.ts +++ /dev/null @@ -1,10 +0,0 @@ -// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -export { - Analytics, - type Components, - type Schema, - type AnalyticsListParams, - type AnalyticsStoredParams, -} from './analytics'; -export { Storage } from './storage'; diff --git a/src/resources/storage/storage.ts b/src/resources/storage/storage.ts deleted file mode 100644 index 76a004e35d2..00000000000 --- a/src/resources/storage/storage.ts +++ /dev/null @@ -1,21 +0,0 @@ -// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -import { APIResource } from '../../resource'; -import * as AnalyticsAPI from './analytics'; -import { Analytics, AnalyticsListParams, AnalyticsStoredParams, Components, Schema } from './analytics'; - -export class Storage extends APIResource { - analytics: AnalyticsAPI.Analytics = new AnalyticsAPI.Analytics(this._client); -} - -Storage.Analytics = Analytics; - -export declare namespace Storage { - export { - Analytics as Analytics, - type Components as Components, - type Schema as Schema, - type AnalyticsListParams as AnalyticsListParams, - type AnalyticsStoredParams as AnalyticsStoredParams, - }; -} diff --git a/tests/api-resources/storage/analytics.test.ts b/tests/api-resources/kv/namespaces/analytics.test.ts similarity index 86% rename from tests/api-resources/storage/analytics.test.ts rename to tests/api-resources/kv/namespaces/analytics.test.ts index 69547abe74e..e949c584ceb 100644 --- a/tests/api-resources/storage/analytics.test.ts +++ b/tests/api-resources/kv/namespaces/analytics.test.ts @@ -11,7 +11,9 @@ const client = new Cloudflare({ describe('resource analytics', () => { test('list: only required params', async () => { - const responsePromise = client.storage.analytics.list({ account_id: '023e105f4ecef8ad9ca31a8372d0c353' }); + const responsePromise = client.kv.namespaces.analytics.list({ + account_id: '023e105f4ecef8ad9ca31a8372d0c353', + }); const rawResponse = await responsePromise.asResponse(); expect(rawResponse).toBeInstanceOf(Response); const response = await responsePromise; @@ -22,7 +24,7 @@ describe('resource analytics', () => { }); test('list: required and optional params', async () => { - const response = await client.storage.analytics.list({ + const response = await client.kv.namespaces.analytics.list({ account_id: '023e105f4ecef8ad9ca31a8372d0c353', query: { dimensions: ['accountId'], @@ -37,7 +39,7 @@ describe('resource analytics', () => { }); test('stored: only required params', async () => { - const responsePromise = client.storage.analytics.stored({ + const responsePromise = client.kv.namespaces.analytics.stored({ account_id: '023e105f4ecef8ad9ca31a8372d0c353', }); const rawResponse = await responsePromise.asResponse(); @@ -50,7 +52,7 @@ describe('resource analytics', () => { }); test('stored: required and optional params', async () => { - const response = await client.storage.analytics.stored({ + const response = await client.kv.namespaces.analytics.stored({ account_id: '023e105f4ecef8ad9ca31a8372d0c353', query: { dimensions: ['namespaceId'],