refactor(jobs): rename getByKey to getById [PLT-100298]

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Author: ninja-shreyash

docs/oauth-scopes.md

@@ -14,7 +14,7 @@ This page lists the specific OAuth scopes required in external app for each SDK
 | Method | OAuth Scope |
 |--------|-------------|
 | `getAll()` | `OR.Jobs` or `OR.Jobs.Read` |
-| `getByKey()` | `OR.Jobs` or `OR.Jobs.Read` |
+| `getById()` | `OR.Jobs` or `OR.Jobs.Read` |
 | `getOutput()` | `OR.Jobs` or `OR.Jobs.Read` |
 
 ## Attachments

src/models/orchestrator/jobs.models.ts

@@ -1,4 +1,4 @@
-import { JobGetAllOptions, JobGetByKeyOptions, RawJobGetResponse } from './jobs.types';
+import { JobGetAllOptions, JobGetByIdOptions, RawJobGetResponse } from './jobs.types';
 import { PaginatedResponse, NonPaginatedResponse, HasPaginationOptions } from '../../utils/pagination';
 
 // Combined type for job data with methods
@@ -81,20 +81,20 @@ export interface JobServiceModel {
    * @example
    * ```typescript
    * // Get a job by key
-   * const job = await jobs.getByKey(<jobKey>, <folderId>);
+   * const job = await jobs.getById(<jobKey>, <folderId>);
    * console.log(job.state, job.processName);
    * ```
    *
    * @example
    * ```typescript
    * // With expanded related entities
-   * const job = await jobs.getByKey(<jobKey>, <folderId>, {
+   * const job = await jobs.getById(<jobKey>, <folderId>, {
    *   expand: 'Robot,Machine,Release'
    * });
    * console.log(job.robot?.name, job.machine?.name);
    * ```
    */
-  getByKey(jobKey: string, folderId: number, options?: JobGetByKeyOptions): Promise<JobGetResponse>;
+  getById(jobKey: string, folderId: number, options?: JobGetByIdOptions): Promise<JobGetResponse>;
 
   /**
    * Gets the output of a completed job.

src/models/orchestrator/jobs.types.ts

@@ -167,7 +167,7 @@ export type JobGetAllOptions = RequestOptions & PaginationOptions & {
 }
 
 /**
- * Options for getting a job by key
+ * Options for getting a job by ID
  */
-export interface JobGetByKeyOptions extends BaseOptions {}
+export interface JobGetByIdOptions extends BaseOptions {}
 

src/services/orchestrator/jobs/jobs.ts

@@ -1,5 +1,5 @@
 import { FolderScopedService } from '../../folder-scoped';
-import { RawJobGetResponse, JobGetAllOptions, JobGetByKeyOptions } from '../../../models/orchestrator/jobs.types';
+import { RawJobGetResponse, JobGetAllOptions, JobGetByIdOptions } from '../../../models/orchestrator/jobs.types';
 import { JobServiceModel, JobGetResponse, createJobWithMethods } from '../../../models/orchestrator/jobs.models';
 import { addPrefixToKeys, pascalToCamelCaseKeys, transformData } from '../../../utils/transform';
 import { JOB_ENDPOINTS } from '../../../utils/constants/endpoints';
@@ -117,24 +117,24 @@ export class JobService extends FolderScopedService implements JobServiceModel {
    *
    * @example
    * ```typescript
-   * // Get a job by key
-   * const job = await jobs.getByKey(<jobKey>, <folderId>);
+   * // Get a job by ID
+   * const job = await jobs.getById(<jobKey>, <folderId>);
    * console.log(job.state, job.processName);
    * ```
    *
    * @example
    * ```typescript
    * // With expanded related entities
-   * const job = await jobs.getByKey(<jobKey>, <folderId>, {
+   * const job = await jobs.getById(<jobKey>, <folderId>, {
    *   expand: 'Robot,Machine,Release'
    * });
    * console.log(job.robot?.name, job.machine?.name);
    * ```
    */
-  @track('Jobs.GetByKey')
-  async getByKey(jobKey: string, folderId: number, options: JobGetByKeyOptions = {}): Promise<JobGetResponse> {
+  @track('Jobs.GetById')
+  async getById(jobKey: string, folderId: number, options: JobGetByIdOptions = {}): Promise<JobGetResponse> {
     if (!jobKey) {
-      throw new ValidationError({ message: 'jobKey is required for getByKey' });
+      throw new ValidationError({ message: 'jobKey is required for getById' });
     }
 
     const headers = createHeaders({ [FOLDER_ID]: folderId });
@@ -191,7 +191,7 @@ export class JobService extends FolderScopedService implements JobServiceModel {
       throw new ValidationError({ message: 'jobKey is required for getOutput' });
     }
 
-    const job = await this.getByKey(jobKey, folderId, { select: 'OutputArguments,OutputFile' });
+    const job = await this.getById(jobKey, folderId, { select: 'OutputArguments,OutputFile' });
 
     if (job.outputArguments) {
       try {

tests/integration/shared/orchestrator/jobs.integration.test.ts

@@ -62,12 +62,12 @@ describe.each(modes)('Orchestrator Jobs - Integration Tests [%s]', (mode) => {
     });
   });
 
-  describe('getByKey', () => {
+  describe('getById', () => {
     it('should retrieve a job by key', async () => {
       const { jobs, folderId } = getJobsService();
 
       if (!folderId) {
-        throw new Error('INTEGRATION_TEST_FOLDER_ID is required for getByKey tests.');
+        throw new Error('INTEGRATION_TEST_FOLDER_ID is required for getById tests.');
       }
 
       // First get a job key from getAll
@@ -77,11 +77,11 @@ describe.each(modes)('Orchestrator Jobs - Integration Tests [%s]', (mode) => {
       });
 
       if (allJobs.items.length === 0) {
-        throw new Error('No jobs available to test getByKey.');
+        throw new Error('No jobs available to test getById.');
       }
 
       const jobKey = allJobs.items[0].key;
-      const job = await jobs.getByKey(jobKey, folderId);
+      const job = await jobs.getById(jobKey, folderId);
 
       expect(job).toBeDefined();
       expect(job.id).toBeDefined();
@@ -94,7 +94,7 @@ describe.each(modes)('Orchestrator Jobs - Integration Tests [%s]', (mode) => {
       const { jobs, folderId } = getJobsService();
 
       if (!folderId) {
-        throw new Error('INTEGRATION_TEST_FOLDER_ID is required for getByKey tests.');
+        throw new Error('INTEGRATION_TEST_FOLDER_ID is required for getById tests.');
       }
 
       const allJobs = await jobs.getAll({
@@ -103,11 +103,11 @@ describe.each(modes)('Orchestrator Jobs - Integration Tests [%s]', (mode) => {
       });
 
       if (allJobs.items.length === 0) {
-        throw new Error('No jobs available to test getByKey with expand.');
+        throw new Error('No jobs available to test getById with expand.');
       }
 
       const jobKey = allJobs.items[0].key;
-      const job = await jobs.getByKey(jobKey, folderId, {
+      const job = await jobs.getById(jobKey, folderId, {
         expand: 'Robot,Machine,Release',
       });
 
@@ -119,7 +119,7 @@ describe.each(modes)('Orchestrator Jobs - Integration Tests [%s]', (mode) => {
       const { jobs, folderId } = getJobsService();
 
       if (!folderId) {
-        throw new Error('INTEGRATION_TEST_FOLDER_ID is required for getByKey tests.');
+        throw new Error('INTEGRATION_TEST_FOLDER_ID is required for getById tests.');
       }
 
       const allJobs = await jobs.getAll({
@@ -128,11 +128,11 @@ describe.each(modes)('Orchestrator Jobs - Integration Tests [%s]', (mode) => {
       });
 
       if (allJobs.items.length === 0) {
-        throw new Error('No jobs available to test getByKey bound methods.');
+        throw new Error('No jobs available to test getById bound methods.');
       }
 
       const jobKey = allJobs.items[0].key;
-      const job = await jobs.getByKey(jobKey, folderId);
+      const job = await jobs.getById(jobKey, folderId);
 
       expect(job.getOutput).toBeDefined();
       expect(typeof job.getOutput).toBe('function');
@@ -142,7 +142,7 @@ describe.each(modes)('Orchestrator Jobs - Integration Tests [%s]', (mode) => {
       const { jobs, folderId } = getJobsService();
 
       if (!folderId) {
-        throw new Error('INTEGRATION_TEST_FOLDER_ID is required for getByKey transform tests.');
+        throw new Error('INTEGRATION_TEST_FOLDER_ID is required for getById transform tests.');
       }
 
       const allJobs = await jobs.getAll({
@@ -155,7 +155,7 @@ describe.each(modes)('Orchestrator Jobs - Integration Tests [%s]', (mode) => {
       }
 
       const jobKey = allJobs.items[0].key;
-      const job = await jobs.getByKey(jobKey, folderId);
+      const job = await jobs.getById(jobKey, folderId);
 
       // Verify transformed camelCase fields exist
       expect(job.createdTime).toBeDefined();

tests/unit/services/orchestrator/jobs.test.ts

@@ -11,7 +11,7 @@ import { createServiceTestDependencies, createMockApiClient } from '../../../uti
 import { createMockError } from '../../../utils/mocks/core';
 import {
   JobGetAllOptions,
-  JobGetByKeyOptions,
+  JobGetByIdOptions,
 } from '../../../../src/models/orchestrator/jobs.types';
 import { JobGetResponse } from '../../../../src/models/orchestrator/jobs.models';
 import { PaginatedResponse } from '../../../../src/utils/pagination';
@@ -176,12 +176,12 @@ describe('JobService Unit Tests', () => {
     });
   });
 
-  describe('getByKey', () => {
+  describe('getById', () => {
     it('should return a job by key with transformed fields', async () => {
       const mockRawJob = createMockRawJob();
       mockApiClient.get.mockResolvedValueOnce(mockRawJob);
 
-      const result = await jobService.getByKey(JOB_TEST_CONSTANTS.JOB_KEY, TEST_CONSTANTS.FOLDER_ID);
+      const result = await jobService.getById(JOB_TEST_CONSTANTS.JOB_KEY, TEST_CONSTANTS.FOLDER_ID);
 
       expect(mockApiClient.get).toHaveBeenCalledWith(
         JOB_ENDPOINTS.GET_BY_KEY(JOB_TEST_CONSTANTS.JOB_KEY),
@@ -206,7 +206,7 @@ describe('JobService Unit Tests', () => {
       const mockRawJob = createMockRawJob();
       mockApiClient.get.mockResolvedValueOnce(mockRawJob);
 
-      const result = await jobService.getByKey(JOB_TEST_CONSTANTS.JOB_KEY, TEST_CONSTANTS.FOLDER_ID);
+      const result = await jobService.getById(JOB_TEST_CONSTANTS.JOB_KEY, TEST_CONSTANTS.FOLDER_ID);
 
       expect((result as any).CreationTime).toBeUndefined();
       expect((result as any).ReleaseName).toBeUndefined();
@@ -219,7 +219,7 @@ describe('JobService Unit Tests', () => {
       const mockRawJob = createMockRawJob();
       mockApiClient.get.mockResolvedValueOnce(mockRawJob);
 
-      const result = await jobService.getByKey(JOB_TEST_CONSTANTS.JOB_KEY, TEST_CONSTANTS.FOLDER_ID);
+      const result = await jobService.getById(JOB_TEST_CONSTANTS.JOB_KEY, TEST_CONSTANTS.FOLDER_ID);
 
       expect(result.getOutput).toBeDefined();
       expect(typeof result.getOutput).toBe('function');
@@ -229,12 +229,12 @@ describe('JobService Unit Tests', () => {
       const mockRawJob = createMockRawJob();
       mockApiClient.get.mockResolvedValueOnce(mockRawJob);
 
-      const options: JobGetByKeyOptions = {
+      const options: JobGetByIdOptions = {
         expand: 'Robot,Machine,Release',
         select: 'Key,State,ReleaseName',
       };
 
-      await jobService.getByKey(JOB_TEST_CONSTANTS.JOB_KEY, TEST_CONSTANTS.FOLDER_ID, options);
+      await jobService.getById(JOB_TEST_CONSTANTS.JOB_KEY, TEST_CONSTANTS.FOLDER_ID, options);
 
       expect(mockApiClient.get).toHaveBeenCalledWith(
         JOB_ENDPOINTS.GET_BY_KEY(JOB_TEST_CONSTANTS.JOB_KEY),
@@ -249,16 +249,16 @@ describe('JobService Unit Tests', () => {
 
     it('should throw validation error when jobKey is missing', async () => {
       await expect(
-        jobService.getByKey('', TEST_CONSTANTS.FOLDER_ID)
-      ).rejects.toThrow('jobKey is required for getByKey');
+        jobService.getById('', TEST_CONSTANTS.FOLDER_ID)
+      ).rejects.toThrow('jobKey is required for getById');
     });
 
     it('should handle API errors', async () => {
       const error = createMockError(JOB_TEST_CONSTANTS.ERROR_JOB_NOT_FOUND);
       mockApiClient.get.mockRejectedValueOnce(error);
 
       await expect(
-        jobService.getByKey(JOB_TEST_CONSTANTS.JOB_KEY, TEST_CONSTANTS.FOLDER_ID)
+        jobService.getById(JOB_TEST_CONSTANTS.JOB_KEY, TEST_CONSTANTS.FOLDER_ID)
       ).rejects.toThrow(JOB_TEST_CONSTANTS.ERROR_JOB_NOT_FOUND);
     });
   });