cloudflare 6.1.0 → 6.3.0

package/src/resources/organizations/billing/usage.ts

@@ -0,0 +1,270 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../resource';
+import { isRequestOptions } from '../../../core';
+import * as Core from '../../../core';
+
+export class Usage extends APIResource {
+  /**
+   * Returns cost and usage data for all accounts within an organization, aligned
+   * with the [FinOps FOCUS v1.3](https://focus.finops.org/focus-specification/v1-3/)
+   * Cost and Usage dataset specification.
+   *
+   * Each record represents one billable metric for one account on one day. This
+   * includes all metered usage, including usage that falls within free-tier
+   * allowances and may result in zero cost. The response includes usage for every
+   * account belonging to the specified organization.
+   *
+   * **Note:** Cost and pricing fields are not yet populated and will be absent from
+   * responses until billing integration is complete.
+   *
+   * When `from` and `to` are omitted, defaults to the start of the current month
+   * through today. The maximum date range is 31 days.
+   */
+  get(
+    organizationId: string,
+    query?: UsageGetParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<UsageGetResponse>;
+  get(organizationId: string, options?: Core.RequestOptions): Core.APIPromise<UsageGetResponse>;
+  get(
+    organizationId: string,
+    query: UsageGetParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<UsageGetResponse> {
+    if (isRequestOptions(query)) {
+      return this.get(organizationId, {}, query);
+    }
+    return (
+      this._client.get(`/organizations/${organizationId}/billable/usage`, {
+        query,
+        ...options,
+      }) as Core.APIPromise<{ result: UsageGetResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+/**
+ * Contains the array of cost and usage records.
+ */
+export type UsageGetResponse = Array<UsageGetResponse.UsageGetResponseItem>;
+
+export namespace UsageGetResponse {
+  /**
+   * A single cost and usage record for a metered product within a specific charge
+   * period, aligned with the FinOps FOCUS v1.3 specification.
+   */
+  export interface UsageGetResponseItem {
+    /**
+     * Public identifier of the Cloudflare account (account tag).
+     */
+    BillingAccountId: string;
+
+    /**
+     * Display name of the Cloudflare account.
+     */
+    BillingAccountName: string;
+
+    /**
+     * Highest-level classification of a charge based on the nature of how it gets
+     * billed. Currently only "Usage" is supported.
+     */
+    ChargeCategory: 'Usage';
+
+    /**
+     * Self-contained summary of the charge's purpose and price.
+     */
+    ChargeDescription: string;
+
+    /**
+     * Indicates how often a charge occurs. Currently only "Usage-Based" is supported.
+     */
+    ChargeFrequency: 'Usage-Based';
+
+    /**
+     * Exclusive end of the time interval during which the usage was consumed.
+     */
+    ChargePeriodEnd: string;
+
+    /**
+     * Inclusive start of the time interval during which the usage was consumed.
+     */
+    ChargePeriodStart: string;
+
+    /**
+     * Measured usage amount within the charge period. Reflects raw metered consumption
+     * before pricing transformations.
+     */
+    ConsumedQuantity: number;
+
+    /**
+     * Unit of measure for the consumed quantity (e.g., "GB", "Requests",
+     * "vCPU-Hours").
+     */
+    ConsumedUnit: string;
+
+    /**
+     * Name of the entity providing the underlying infrastructure or platform.
+     */
+    HostProviderName: string;
+
+    /**
+     * Name of the entity responsible for invoicing for the services consumed.
+     */
+    InvoiceIssuerName: string;
+
+    /**
+     * Name of the entity that made the services available for purchase.
+     */
+    ServiceProviderName: string;
+
+    /**
+     * The display name of the billable metric. Cloudflare extension; replaces FOCUS
+     * SkuMeter.
+     */
+    x_BillableMetricName: string;
+
+    /**
+     * A charge serving as the basis for invoicing, inclusive of all reduced rates and
+     * discounts while excluding the amortization of upfront charges (one-time or
+     * recurring).
+     */
+    BilledCost?: number | null;
+
+    /**
+     * Currency that a charge was billed in (ISO 4217).
+     */
+    BillingCurrency?: string | null;
+
+    /**
+     * Exclusive end of the billing cycle that contains this usage record.
+     */
+    BillingPeriodEnd?: string | null;
+
+    /**
+     * Inclusive start of the billing cycle that contains this usage record.
+     */
+    BillingPeriodStart?: string | null;
+
+    /**
+     * Indicates whether the row represents a correction to one or more charges
+     * invoiced in a previous billing period.
+     */
+    ChargeClass?: 'Correction' | null;
+
+    /**
+     * Cost calculated by multiplying ContractedUnitPrice and the corresponding
+     * PricingQuantity.
+     */
+    ContractedCost?: number | null;
+
+    /**
+     * The agreed-upon unit price for a single PricingUnit of the associated billable
+     * metric, inclusive of negotiated discounts, if present, while excluding any other
+     * discounts.
+     */
+    ContractedUnitPrice?: number | null;
+
+    /**
+     * The amortized cost of the charge after applying all reduced rates, discounts,
+     * and the applicable portion of relevant, prepaid purchases (one-time or
+     * recurring) that covered the charge.
+     */
+    EffectiveCost?: number | null;
+
+    /**
+     * Cost calculated by multiplying ListUnitPrice and the corresponding
+     * PricingQuantity.
+     */
+    ListCost?: number | null;
+
+    /**
+     * Suggested provider-published unit price for a single PricingUnit of the
+     * associated billable metric, exclusive of any discounts.
+     */
+    ListUnitPrice?: number | null;
+
+    /**
+     * Volume of a given service used or purchased, based on the PricingUnit.
+     */
+    PricingQuantity?: number | null;
+
+    /**
+     * Provider-specified measurement unit for determining unit prices, indicating how
+     * the provider rates measured usage after applying pricing rules like block
+     * pricing.
+     */
+    PricingUnit?: string | null;
+
+    /**
+     * Provider-assigned identifier for an isolated geographic area where a service is
+     * provided.
+     */
+    RegionId?: string | null;
+
+    /**
+     * Name of an isolated geographic area where a service is provided.
+     */
+    RegionName?: string | null;
+
+    /**
+     * Unique identifier assigned to a grouping of services. For Cloudflare, this is
+     * the subscription or contract ID.
+     */
+    SubAccountId?: string;
+
+    /**
+     * Name assigned to a grouping of services. For Cloudflare, this is the
+     * subscription or contract display name.
+     */
+    SubAccountName?: string;
+
+    /**
+     * The unique identifier for the billable metric in the Cloudflare catalog.
+     * Cloudflare extension; replaces FOCUS SkuId.
+     */
+    x_BillableMetricId?: string;
+
+    /**
+     * The product family the charge belongs to (e.g., "R2", "Workers"). Cloudflare
+     * extension; replaces FOCUS ServiceName.
+     */
+    x_ProductFamilyName?: string;
+
+    /**
+     * The identifier for the Cloudflare zone (zone tag). Cloudflare extension.
+     */
+    x_ZoneId?: string | null;
+
+    /**
+     * The display name of the Cloudflare zone. Cloudflare extension.
+     */
+    x_ZoneName?: string | null;
+  }
+}
+
+export interface UsageGetParams {
+  /**
+   * Start date for the usage query (ISO 8601). Required if `to` is set. When omitted
+   * along with `to`, defaults to the start of the current month. Filters by charge
+   * period (when consumption happened), not billing period. The maximum date range
+   * is 31 days.
+   */
+  from?: string;
+
+  /**
+   * Filter results by billable metric id (e.g., workers_standard_requests).
+   */
+  metric?: string;
+
+  /**
+   * End date for the usage query (ISO 8601). Required if `from` is set. When omitted
+   * along with `from`, defaults to today. Filters by charge period (when consumption
+   * happened), not billing period. The maximum date range is 31 days.
+   */
+  to?: string;
+}
+
+export declare namespace Usage {
+  export { type UsageGetResponse as UsageGetResponse, type UsageGetParams as UsageGetParams };
+}

package/src/resources/organizations/billing.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './billing/index';

package/src/resources/organizations/index.ts

@@ -1,5 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export { Billing } from './billing/index';
 export { Logs } from './logs/index';
 export {
   OrganizationProfileResource,

package/src/resources/organizations/organization-profile.ts

@@ -5,7 +5,7 @@ import * as Core from '../../core';
 
 export class OrganizationProfileResource extends APIResource {
   /**
-   * Modify organization profile. (Currently in Closed Beta - see
+   * Modify organization profile. (Currently in Public Beta - see
    * https://developers.cloudflare.com/fundamentals/organizations/)
    */
   update(
@@ -21,7 +21,7 @@ export class OrganizationProfileResource extends APIResource {
   }
 
   /**
-   * Get an organizations profile if it exists. (Currently in Closed Beta - see
+   * Get an organizations profile if it exists. (Currently in Public Beta - see
    * https://developers.cloudflare.com/fundamentals/organizations/)
    */
   get(organizationId: string, options?: Core.RequestOptions): Core.APIPromise<OrganizationProfile> {

package/src/resources/organizations/organizations.ts

@@ -9,6 +9,8 @@ import {
   OrganizationProfileResource,
   OrganizationProfileUpdateParams,
 } from './organization-profile';
+import * as BillingAPI from './billing/billing';
+import { Billing } from './billing/billing';
 import * as LogsAPI from './logs/logs';
 import { Logs } from './logs/logs';
 import { SinglePage } from '../../pagination';
@@ -17,9 +19,10 @@ export class Organizations extends APIResource {
   organizationProfile: OrganizationProfileAPI.OrganizationProfileResource =
     new OrganizationProfileAPI.OrganizationProfileResource(this._client);
   logs: LogsAPI.Logs = new LogsAPI.Logs(this._client);
+  billing: BillingAPI.Billing = new BillingAPI.Billing(this._client);
 
   /**
-   * Create a new organization for a user. (Currently in Closed Beta - see
+   * Create a new organization for a user. (Currently in Public Beta - see
    * https://developers.cloudflare.com/fundamentals/organizations/)
    */
   create(body: OrganizationCreateParams, options?: Core.RequestOptions): Core.APIPromise<Organization> {
@@ -29,7 +32,7 @@ export class Organizations extends APIResource {
   }
 
   /**
-   * Modify organization. (Currently in Closed Beta - see
+   * Modify organization. (Currently in Public Beta - see
    * https://developers.cloudflare.com/fundamentals/organizations/)
    */
   update(
@@ -46,7 +49,7 @@ export class Organizations extends APIResource {
 
   /**
    * Retrieve a list of organizations a particular user has access to. (Currently in
-   * Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)
+   * Public Beta - see https://developers.cloudflare.com/fundamentals/organizations/)
    */
   list(
     query?: OrganizationListParams,
@@ -66,7 +69,7 @@ export class Organizations extends APIResource {
   /**
    * Delete an organization. The organization MUST be empty before deleting. It must
    * not contain any sub-organizations, accounts, members or users. (Currently in
-   * Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)
+   * Public Beta - see https://developers.cloudflare.com/fundamentals/organizations/)
    */
   delete(organizationId: string, options?: Core.RequestOptions): Core.APIPromise<OrganizationDeleteResponse> {
     return (
@@ -77,7 +80,7 @@ export class Organizations extends APIResource {
   }
 
   /**
-   * Retrieve the details of a certain organization. (Currently in Closed Beta - see
+   * Retrieve the details of a certain organization. (Currently in Public Beta - see
    * https://developers.cloudflare.com/fundamentals/organizations/)
    */
   get(organizationId: string, options?: Core.RequestOptions): Core.APIPromise<Organization> {
@@ -300,6 +303,7 @@ export namespace OrganizationListParams {
 Organizations.OrganizationsSinglePage = OrganizationsSinglePage;
 Organizations.OrganizationProfileResource = OrganizationProfileResource;
 Organizations.Logs = Logs;
+Organizations.Billing = Billing;
 
 export declare namespace Organizations {
   export {
@@ -318,4 +322,6 @@ export declare namespace Organizations {
   };
 
   export { Logs as Logs };
+
+  export { Billing as Billing };
 }

package/src/resources/r2/api.md

@@ -126,6 +126,21 @@ Methods:
 - <code title="delete /accounts/{account_id}/r2/buckets/{bucket_name}/sippy">client.r2.buckets.sippy.<a href="./src/resources/r2/buckets/sippy.ts">delete</a>(bucketName, { ...params }) -> SippyDeleteResponse</code>
 - <code title="get /accounts/{account_id}/r2/buckets/{bucket_name}/sippy">client.r2.buckets.sippy.<a href="./src/resources/r2/buckets/sippy.ts">get</a>(bucketName, { ...params }) -> Sippy</code>
 
+### Objects
+
+Types:
+
+- <code><a href="./src/resources/r2/buckets/objects.ts">ObjectListResponse</a></code>
+- <code><a href="./src/resources/r2/buckets/objects.ts">ObjectDeleteResponse</a></code>
+- <code><a href="./src/resources/r2/buckets/objects.ts">ObjectUploadResponse</a></code>
+
+Methods:
+
+- <code title="get /accounts/{account_id}/r2/buckets/{bucket_name}/objects">client.r2.buckets.objects.<a href="./src/resources/r2/buckets/objects.ts">list</a>(bucketName, { ...params }) -> ObjectListResponsesCursorPagination</code>
+- <code title="delete /accounts/{account_id}/r2/buckets/{bucket_name}/objects/{object_key}">client.r2.buckets.objects.<a href="./src/resources/r2/buckets/objects.ts">delete</a>(bucketName, objectKey, { ...params }) -> ObjectDeleteResponse</code>
+- <code title="get /accounts/{account_id}/r2/buckets/{bucket_name}/objects/{object_key}">client.r2.buckets.objects.<a href="./src/resources/r2/buckets/objects.ts">get</a>(bucketName, objectKey, { ...params }) -> Response</code>
+- <code title="put /accounts/{account_id}/r2/buckets/{bucket_name}/objects/{object_key}">client.r2.buckets.objects.<a href="./src/resources/r2/buckets/objects.ts">upload</a>(bucketName, objectKey, body, { ...params }) -> ObjectUploadResponse</code>
+
 ## TemporaryCredentials
 
 Types:

package/src/resources/r2/buckets/buckets.ts

@@ -36,6 +36,18 @@ import * as LocksAPI from './locks';
 import { LockGetParams, LockGetResponse, LockUpdateParams, LockUpdateResponse, Locks } from './locks';
 import * as MetricsAPI from './metrics';
 import { MetricListParams, MetricListResponse, Metrics } from './metrics';
+import * as ObjectsAPI from './objects';
+import {
+  ObjectDeleteParams,
+  ObjectDeleteResponse,
+  ObjectGetParams,
+  ObjectListParams,
+  ObjectListResponse,
+  ObjectListResponsesCursorPagination,
+  ObjectUploadParams,
+  ObjectUploadResponse,
+  Objects,
+} from './objects';
 import * as SippyAPI from './sippy';
 import {
   Provider,
@@ -59,6 +71,7 @@ export class Buckets extends APIResource {
   locks: LocksAPI.Locks = new LocksAPI.Locks(this._client);
   metrics: MetricsAPI.Metrics = new MetricsAPI.Metrics(this._client);
   sippy: SippyAPI.SippyResource = new SippyAPI.SippyResource(this._client);
+  objects: ObjectsAPI.Objects = new ObjectsAPI.Objects(this._client);
 
   /**
    * Creates a new R2 bucket.
@@ -363,6 +376,8 @@ Buckets.EventNotifications = EventNotifications;
 Buckets.Locks = Locks;
 Buckets.Metrics = Metrics;
 Buckets.SippyResource = SippyResource;
+Buckets.Objects = Objects;
+Buckets.ObjectListResponsesCursorPagination = ObjectListResponsesCursorPagination;
 
 export declare namespace Buckets {
   export {
@@ -431,4 +446,16 @@ export declare namespace Buckets {
     type SippyDeleteParams as SippyDeleteParams,
     type SippyGetParams as SippyGetParams,
   };
+
+  export {
+    Objects as Objects,
+    type ObjectListResponse as ObjectListResponse,
+    type ObjectDeleteResponse as ObjectDeleteResponse,
+    type ObjectUploadResponse as ObjectUploadResponse,
+    ObjectListResponsesCursorPagination as ObjectListResponsesCursorPagination,
+    type ObjectListParams as ObjectListParams,
+    type ObjectDeleteParams as ObjectDeleteParams,
+    type ObjectGetParams as ObjectGetParams,
+    type ObjectUploadParams as ObjectUploadParams,
+  };
 }

package/src/resources/r2/buckets/index.ts

@@ -47,6 +47,17 @@ export {
   type LockGetParams,
 } from './locks';
 export { Metrics, type MetricListResponse, type MetricListParams } from './metrics';
+export {
+  ObjectListResponsesCursorPagination,
+  Objects,
+  type ObjectListResponse,
+  type ObjectDeleteResponse,
+  type ObjectUploadResponse,
+  type ObjectListParams,
+  type ObjectDeleteParams,
+  type ObjectGetParams,
+  type ObjectUploadParams,
+} from './objects';
 export {
   SippyResource,
   type Provider,