feat: feat(leaked_credentials_check): Add GET endpoint for leaked_credentials_check/detections

* feat(leaked_credentials_check): Add GET endpoint for leaked_credentials_check/detections

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 1924
+configured_endpoints: 1925
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-5fc91fe703941755eabe8e53f6d53056d31c38bff2f098dfa2389512e52b586f.yml
 openapi_spec_hash: 7d4707f46e5b07408d6a083bfe164f51
-config_hash: d300d915a7b88f436c0498af4048e337
+config_hash: 93c66810e920a180099213f0e36aacbd

api.md

@@ -8798,13 +8798,15 @@ Types:
 - <code><a href="./src/resources/leaked-credential-checks/detections.ts">DetectionUpdateResponse</a></code>
 - <code><a href="./src/resources/leaked-credential-checks/detections.ts">DetectionListResponse</a></code>
 - <code><a href="./src/resources/leaked-credential-checks/detections.ts">DetectionDeleteResponse</a></code>
+- <code><a href="./src/resources/leaked-credential-checks/detections.ts">DetectionGetResponse</a></code>
 
 Methods:
 
 - <code title="post /zones/{zone_id}/leaked-credential-checks/detections">client.leakedCredentialChecks.detections.<a href="./src/resources/leaked-credential-checks/detections.ts">create</a>({ ...params }) -> DetectionCreateResponse</code>
 - <code title="put /zones/{zone_id}/leaked-credential-checks/detections/{detection_id}">client.leakedCredentialChecks.detections.<a href="./src/resources/leaked-credential-checks/detections.ts">update</a>(detectionId, { ...params }) -> DetectionUpdateResponse</code>
 - <code title="get /zones/{zone_id}/leaked-credential-checks/detections">client.leakedCredentialChecks.detections.<a href="./src/resources/leaked-credential-checks/detections.ts">list</a>({ ...params }) -> DetectionListResponsesSinglePage</code>
 - <code title="delete /zones/{zone_id}/leaked-credential-checks/detections/{detection_id}">client.leakedCredentialChecks.detections.<a href="./src/resources/leaked-credential-checks/detections.ts">delete</a>(detectionId, { ...params }) -> DetectionDeleteResponse</code>
+- <code title="get /zones/{zone_id}/leaked-credential-checks/detections/{detection_id}">client.leakedCredentialChecks.detections.<a href="./src/resources/leaked-credential-checks/detections.ts">get</a>(detectionId, { ...params }) -> DetectionGetResponse</code>
 
 # ContentScanning
 

src/resources/leaked-credential-checks/detections.ts

@@ -105,6 +105,32 @@ export class Detections extends APIResource {
       ) as Core.APIPromise<{ result: DetectionDeleteResponse }>
     )._thenUnwrap((obj) => obj.result);
   }
+
+  /**
+   * Get user-defined detection pattern for Leaked Credential Checks.
+   *
+   * @example
+   * ```ts
+   * const detection =
+   *   await client.leakedCredentialChecks.detections.get(
+   *     '18a14bafaa8eb1df04ce683ec18c765e',
+   *     { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   *   );
+   * ```
+   */
+  get(
+    detectionId: string,
+    params: DetectionGetParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<DetectionGetResponse> {
+    const { zone_id } = params;
+    return (
+      this._client.get(
+        `/zones/${zone_id}/leaked-credential-checks/detections/${detectionId}`,
+        options,
+      ) as Core.APIPromise<{ result: DetectionGetResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
 }
 
 export class DetectionListResponsesSinglePage extends SinglePage<DetectionListResponse> {}
@@ -174,6 +200,27 @@ export interface DetectionListResponse {
 
 export type DetectionDeleteResponse = unknown;
 
+/**
+ * Defines a custom set of username/password expressions to match Leaked Credential
+ * Checks on.
+ */
+export interface DetectionGetResponse {
+  /**
+   * Defines the unique ID for this custom detection.
+   */
+  id?: string;
+
+  /**
+   * Defines ehe ruleset expression to use in matching the password in a request.
+   */
+  password?: string;
+
+  /**
+   * Defines the ruleset expression to use in matching the username in a request.
+   */
+  username?: string;
+}
+
 export interface DetectionCreateParams {
   /**
    * Path param: Defines an identifier.
@@ -226,6 +273,13 @@ export interface DetectionDeleteParams {
   zone_id: string;
 }
 
+export interface DetectionGetParams {
+  /**
+   * Defines an identifier.
+   */
+  zone_id: string;
+}
+
 Detections.DetectionListResponsesSinglePage = DetectionListResponsesSinglePage;
 
 export declare namespace Detections {
@@ -234,10 +288,12 @@ export declare namespace Detections {
     type DetectionUpdateResponse as DetectionUpdateResponse,
     type DetectionListResponse as DetectionListResponse,
     type DetectionDeleteResponse as DetectionDeleteResponse,
+    type DetectionGetResponse as DetectionGetResponse,
     DetectionListResponsesSinglePage as DetectionListResponsesSinglePage,
     type DetectionCreateParams as DetectionCreateParams,
     type DetectionUpdateParams as DetectionUpdateParams,
     type DetectionListParams as DetectionListParams,
     type DetectionDeleteParams as DetectionDeleteParams,
+    type DetectionGetParams as DetectionGetParams,
   };
 }

src/resources/leaked-credential-checks/index.ts

@@ -7,9 +7,11 @@ export {
   type DetectionUpdateResponse,
   type DetectionListResponse,
   type DetectionDeleteResponse,
+  type DetectionGetResponse,
   type DetectionCreateParams,
   type DetectionUpdateParams,
   type DetectionListParams,
   type DetectionDeleteParams,
+  type DetectionGetParams,
 } from './detections';
 export { LeakedCredentialChecks } from './leaked-credential-checks';

src/resources/leaked-credential-checks/leaked-credential-checks.ts

@@ -8,6 +8,8 @@ import {
   DetectionCreateResponse,
   DetectionDeleteParams,
   DetectionDeleteResponse,
+  DetectionGetParams,
+  DetectionGetResponse,
   DetectionListParams,
   DetectionListResponse,
   DetectionListResponsesSinglePage,
@@ -123,10 +125,12 @@ export declare namespace LeakedCredentialChecks {
     type DetectionUpdateResponse as DetectionUpdateResponse,
     type DetectionListResponse as DetectionListResponse,
     type DetectionDeleteResponse as DetectionDeleteResponse,
+    type DetectionGetResponse as DetectionGetResponse,
     DetectionListResponsesSinglePage as DetectionListResponsesSinglePage,
     type DetectionCreateParams as DetectionCreateParams,
     type DetectionUpdateParams as DetectionUpdateParams,
     type DetectionListParams as DetectionListParams,
     type DetectionDeleteParams as DetectionDeleteParams,
+    type DetectionGetParams as DetectionGetParams,
   };
 }

tests/api-resources/leaked-credential-checks/detections.test.ts

@@ -95,4 +95,23 @@ describe('resource detections', () => {
       { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
     );
   });
+
+  test('get: only required params', async () => {
+    const responsePromise = client.leakedCredentialChecks.detections.get('18a14bafaa8eb1df04ce683ec18c765e', {
+      zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+    });
+    const rawResponse = await responsePromise.asResponse();
+    expect(rawResponse).toBeInstanceOf(Response);
+    const response = await responsePromise;
+    expect(response).not.toBeInstanceOf(Response);
+    const dataAndResponse = await responsePromise.withResponse();
+    expect(dataAndResponse.data).toBe(response);
+    expect(dataAndResponse.response).toBe(rawResponse);
+  });
+
+  test('get: required and optional params', async () => {
+    const response = await client.leakedCredentialChecks.detections.get('18a14bafaa8eb1df04ce683ec18c765e', {
+      zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+    });
+  });
 });