feat(api): add per endpoint security

Author: stainless-app[bot]

.github/workflows/release-doctor.yml

@@ -19,4 +19,3 @@ jobs:
           bash ./bin/check-release-environment
         env:
           NPM_TOKEN: ${{ secrets.FINCH_NPM_TOKEN || secrets.NPM_TOKEN }}
-

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 46
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-46f433f34d440aa1dfcc48cc8d822c598571b68be2f723ec99e1b4fba6c13b1e.yml
 openapi_spec_hash: 5b5cd728776723ac773900f7e8a32c05
-config_hash: 0892e2e0eeb0343a022afa62e9080dd1
+config_hash: 83522e0e335cf983f8d2119c1f2bba18

src/client.ts

@@ -302,8 +302,14 @@ export class Finch {
     );
   }
 
-  protected async authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined> {
-    return buildHeaders([await this.bearerAuth(opts), await this.basicAuth(opts)]);
+  protected async authHeaders(
+    opts: FinalRequestOptions,
+    schemes: { bearerAuth?: boolean; basicAuth?: boolean },
+  ): Promise<NullableHeaders | undefined> {
+    return buildHeaders([
+      schemes.bearerAuth ? await this.bearerAuth(opts) : null,
+      schemes.basicAuth ? await this.basicAuth(opts) : null,
+    ]);
   }
 
   protected async bearerAuth(opts: FinalRequestOptions): Promise<NullableHeaders | undefined> {
@@ -768,7 +774,7 @@ export class Finch {
         ...getPlatformHeaders(),
         'Finch-API-Version': '2020-09-17',
       },
-      await this.authHeaders(options),
+      await this.authHeaders(options, options.__security ?? { bearerAuth: true, basicAuth: true }),
       this._options.defaultHeaders,
       bodyHeaders,
       options.headers,

src/internal/request-options.ts

@@ -75,6 +75,8 @@ export type RequestOptions = {
    */
   defaultBaseURL?: string | undefined;
 
+  __security?: { bearerAuth?: boolean; basicAuth?: boolean };
+
   __binaryResponse?: boolean | undefined;
 };
 

src/resources/access-tokens.ts

@@ -32,6 +32,7 @@ export class AccessTokens extends APIResource {
       body: bodyWithReplacements,
       ...options,
       headers: headersWithReplacements,
+      __security: {},
     });
   }
 }

src/resources/account.ts

@@ -10,14 +10,14 @@ export class Account extends APIResource {
    * Disconnect one or more `access_token`s from your application.
    */
   disconnect(options?: RequestOptions): APIPromise<DisconnectResponse> {
-    return this._client.post('/disconnect', options);
+    return this._client.post('/disconnect', { ...options, __security: { bearerAuth: true } });
   }
 
   /**
    * Read account information associated with an `access_token`
    */
   introspect(options?: RequestOptions): APIPromise<Introspection> {
-    return this._client.get('/introspect', options);
+    return this._client.get('/introspect', { ...options, __security: { bearerAuth: true } });
   }
 }
 

src/resources/connect/sessions.ts

@@ -9,7 +9,7 @@ export class Sessions extends APIResource {
    * Create a new connect session for an employer
    */
   new(body: SessionNewParams, options?: RequestOptions): APIPromise<SessionNewResponse> {
-    return this._client.post('/connect/sessions', { body, ...options });
+    return this._client.post('/connect/sessions', { body, ...options, __security: { basicAuth: true } });
   }
 
   /**
@@ -19,7 +19,11 @@ export class Sessions extends APIResource {
     body: SessionReauthenticateParams,
     options?: RequestOptions,
   ): APIPromise<SessionReauthenticateResponse> {
-    return this._client.post('/connect/sessions/reauthenticate', { body, ...options });
+    return this._client.post('/connect/sessions/reauthenticate', {
+      body,
+      ...options,
+      __security: { basicAuth: true },
+    });
   }
 }
 

src/resources/hris/benefits/benefits.ts

@@ -38,7 +38,12 @@ export class Benefits extends APIResource {
     options?: RequestOptions,
   ): APIPromise<CreateCompanyBenefitsResponse> {
     const { entity_ids, ...body } = params ?? {};
-    return this._client.post('/employer/benefits', { query: { entity_ids }, body, ...options });
+    return this._client.post('/employer/benefits', {
+      query: { entity_ids },
+      body,
+      ...options,
+      __security: { bearerAuth: true },
+    });
   }
 
   /**
@@ -56,7 +61,11 @@ export class Benefits extends APIResource {
     query: BenefitRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<CompanyBenefit> {
-    return this._client.get(path`/employer/benefits/${benefitID}`, { query, ...options });
+    return this._client.get(path`/employer/benefits/${benefitID}`, {
+      query,
+      ...options,
+      __security: { bearerAuth: true },
+    });
   }
 
   /**
@@ -78,6 +87,7 @@ export class Benefits extends APIResource {
       query: { entity_ids },
       body,
       ...options,
+      __security: { bearerAuth: true },
     });
   }
 
@@ -96,7 +106,11 @@ export class Benefits extends APIResource {
     query: BenefitListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<CompanyBenefitsSinglePage, CompanyBenefit> {
-    return this._client.getAPIList('/employer/benefits', SinglePage<CompanyBenefit>, { query, ...options });
+    return this._client.getAPIList('/employer/benefits', SinglePage<CompanyBenefit>, {
+      query,
+      ...options,
+      __security: { bearerAuth: true },
+    });
   }
 
   /**
@@ -117,6 +131,7 @@ export class Benefits extends APIResource {
     return this._client.getAPIList('/employer/benefits/meta', SinglePage<SupportedBenefit>, {
       query,
       ...options,
+      __security: { bearerAuth: true },
     });
   }
 }

src/resources/hris/benefits/individuals.ts

@@ -31,6 +31,7 @@ export class Individuals extends APIResource {
       query: { entity_ids },
       body: individuals,
       ...options,
+      __security: { bearerAuth: true },
     });
   }
 
@@ -50,7 +51,11 @@ export class Individuals extends APIResource {
     query: IndividualEnrolledIDsParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<IndividualEnrolledIDsResponse> {
-    return this._client.get(path`/employer/benefits/${benefitID}/enrolled`, { query, ...options });
+    return this._client.get(path`/employer/benefits/${benefitID}/enrolled`, {
+      query,
+      ...options,
+      __security: { bearerAuth: true },
+    });
   }
 
   /**
@@ -74,7 +79,7 @@ export class Individuals extends APIResource {
     return this._client.getAPIList(
       path`/employer/benefits/${benefitID}/individuals`,
       SinglePage<IndividualBenefit>,
-      { query, ...options },
+      { query, ...options, __security: { bearerAuth: true } },
     );
   }
 
@@ -99,6 +104,7 @@ export class Individuals extends APIResource {
       query: { entity_ids },
       body,
       ...options,
+      __security: { bearerAuth: true },
     });
   }
 }

src/resources/hris/company/company.ts

@@ -29,7 +29,7 @@ export class CompanyResource extends APIResource {
     query: CompanyRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<Company> {
-    return this._client.get('/employer/company', { query, ...options });
+    return this._client.get('/employer/company', { query, ...options, __security: { bearerAuth: true } });
   }
 }