docs(api-calls): updated to uppercase method names

Updated all method argument to `call` to uppercase for consistency

Author: nandi95

docs/calliope/api-calls.md

@@ -98,7 +98,7 @@ import User from '@Models/User';
 
 const user = new User();
 
-await user.call('get', { query: 'value' }); // GET your-api.com/users?query=value
+await user.call('GET', { query: 'value' }); // GET your-api.com/users?query=value
 ```
 
 ### Endpoint manipulation

src/Calliope/Concerns/CallsApi.ts

@@ -177,7 +177,7 @@ export default class CallsApi extends BuildsQuery {
     public async get<T extends Model = this>(
         queryParameters?: QueryParams & Record<string, unknown>
     ): Promise<ModelCollection<T> | T> {
-        return this.call('get', queryParameters)
+        return this.call('GET', queryParameters)
             .then(responseData => this.newInstanceFromResponseData<T>(this.getDataFromResponse(responseData)));
     }
 
@@ -204,7 +204,7 @@ export default class CallsApi extends BuildsQuery {
      */
     // @ts-expect-error - despite TS2526, it still infers correctly
     public async post<T extends Model = this>(data: Attributes | FormData): Promise<T> {
-        return this.call('post', data)
+        return this.call('POST', data)
             .then(responseData => this.getResponseModel<T>(this.getDataFromResponse(responseData)));
     }
 
@@ -217,7 +217,7 @@ export default class CallsApi extends BuildsQuery {
      */
     // @ts-expect-error - despite TS2526, it still infers correctly
     public async put<T extends Model = this>(data: Attributes | FormData): Promise<T> {
-        return this.call('put', data)
+        return this.call('PUT', data)
             .then(responseData => this.getResponseModel<T>(this.getDataFromResponse(responseData)));
     }
 
@@ -230,7 +230,7 @@ export default class CallsApi extends BuildsQuery {
      */
     // @ts-expect-error - despite TS2526, it still infers correctly
     public async patch<T extends Model = this>(data: Attributes | FormData): Promise<T> {
-        return this.call('patch', data)
+        return this.call('PATCH', data)
             .then(responseData => this.getResponseModel<T>(this.getDataFromResponse(responseData)));
     }
 
@@ -244,7 +244,7 @@ export default class CallsApi extends BuildsQuery {
      */
     // @ts-expect-error - despite TS2526, it still infers correctly
     public async delete<T extends Model = this>(data?: Attributes | FormData): Promise<T> {
-        return this.call('delete', data)
+        return this.call('DELETE', data)
             .then(responseData => this.getResponseModel<T>(this.getDataFromResponse(responseData)));
     }
 

tests/Calliope/Concerns/CallsApi.test.ts

@@ -32,15 +32,15 @@ describe('CallsApi', () => {
     describe('.serverAttributeCasing', () => {
         it('should cast the outgoing attributes to the set serverAttributeCasing', async () => {
             fetchMock.mockResponseOnce(async () => Promise.resolve(buildResponse(User.factory().raw())));
-            await caller.call('post', { someValue: 1 });
+            await caller.call('POST', { someValue: 1 });
 
             // eslint-disable-next-line @typescript-eslint/naming-convention
             expect(getLastRequest()?.body).toStrictEqual({ some_value: 1 });
         });
 
         it('should recursively cast the keys to any depth', async () => {
             fetchMock.mockResponseOnce(async () => Promise.resolve(buildResponse(User.factory().raw())));
-            await caller.call('post', {
+            await caller.call('POST', {
                 someValue: {
                     anotherValue: 1
                 }
@@ -61,7 +61,7 @@ describe('CallsApi', () => {
 
             const user = new UserWithSnakeCase;
 
-            await user.call('post', {
+            await user.call('POST', {
                 // eslint-disable-next-line @typescript-eslint/naming-convention
                 some_value: {
                     // eslint-disable-next-line @typescript-eslint/naming-convention
@@ -77,7 +77,7 @@ describe('CallsApi', () => {
             formData.append('my_field', 'value');
             fetchMock.mockResponseOnce(async () => Promise.resolve(buildResponse(User.factory().raw())));
 
-            await caller.call('post', formData);
+            await caller.call('POST', formData);
 
             expect((getLastRequest()?.body as FormData).has('my_field')).toBe(true);
             expect((getLastRequest()?.body as FormData).has('myField')).toBe(false);
@@ -99,7 +99,7 @@ describe('CallsApi', () => {
             caller.setEndpoint('');
 
             // awkward syntax comes from https://github.com/facebook/jest/issues/1700
-            await expect(caller.call('get')).rejects.toStrictEqual(
+            await expect(caller.call('GET')).rejects.toStrictEqual(
                 new LogicException(
                     'Endpoint is not defined when calling \'get\' method on \'' + caller.constructor.name + '\'.'
                 )
@@ -109,18 +109,18 @@ describe('CallsApi', () => {
         it('should get the endpoint from the model as expected', async () => {
             const baseEndpoint = config.get('baseEndPoint');
             fetchMock.mockResponse(async () => Promise.resolve(buildResponse()));
-            await caller.call('get');
+            await caller.call('GET');
             // it adds the '/' between the baseEndPoint and the endpoint
             expect(getLastRequest()?.url).toBe(finish(baseEndpoint!, '/') + caller.getEndpoint());
 
             config.unset('baseEndPoint');
-            await caller.call('get');
+            await caller.call('GET');
             // if no baseEndPoint is set, we have no leading '/'
             expect(getLastRequest()?.url).toBe(caller.getEndpoint());
 
             config.set('baseEndPoint', baseEndpoint);
             caller.getEndpoint = () => 'https://test-domain.com/users';
-            await caller.call('get');
+            await caller.call('GET');
             // it just appends the value regardless of if it's a valid url
             expect(getLastRequest()?.url).toBe(finish(baseEndpoint!, '/') + caller.getEndpoint());
 
@@ -129,7 +129,7 @@ describe('CallsApi', () => {
 
         it('should return a promise with the response',  async () => {
             fetchMock.mockResponseOnce(async () => Promise.resolve(buildResponse(User.factory().raw())));
-            const responseData = await caller.call('get');
+            const responseData = await caller.call('GET');
 
             expect(responseData).toStrictEqual(User.factory().raw());
         });
@@ -147,7 +147,7 @@ describe('CallsApi', () => {
             config.set('api', api);
 
             fetchMock.mockResponseOnce(async () => Promise.resolve(buildResponse()));
-            await caller.call('get');
+            await caller.call('GET');
             expect(getLastRequest()?.headers.has('custom')).toBe(true);
             expect(getLastRequest()?.headers.get('custom')).toBe('header');
         });
@@ -163,7 +163,7 @@ describe('CallsApi', () => {
             config.set('apiResponseHandler', apiResponseHandler);
 
             fetchMock.mockResponseOnce(async () => Promise.resolve(buildResponse()));
-            await caller.call('get');
+            await caller.call('GET');
             expect(mockFn).toHaveBeenCalled();
         });
 
@@ -172,8 +172,8 @@ describe('CallsApi', () => {
                 async () => Promise.resolve(buildResponse((User.factory().create() as User).getRawOriginal()))
             );
 
-            const promise1 = caller.call('get');
-            const promise2 = caller.call('get');
+            const promise1 = caller.call('GET');
+            const promise2 = caller.call('GET');
 
             // @ts-expect-error
             expect(caller.requestCount).toBe(2);
@@ -189,7 +189,7 @@ describe('CallsApi', () => {
                 async () => Promise.resolve(buildResponse((User.factory().create() as User).getRawOriginal()))
             );
 
-            const promise = caller.call('get');
+            const promise = caller.call('GET');
 
             expect(caller.loading).toBe(true);
 
@@ -200,7 +200,7 @@ describe('CallsApi', () => {
 
         it('should send all the given data', async () => {
             fetchMock.mockResponseOnce(async () => Promise.resolve(buildResponse(User.factory().raw())));
-            await caller.call('post', {
+            await caller.call('POST', {
                 falsyKey1: null,
                 falsyKey2: undefined,
                 falsyKey3: false,
@@ -220,7 +220,7 @@ describe('CallsApi', () => {
         it('should not parse the response body if data wrapped', async () => {
             const data = User.factory().raw();
             fetchMock.mockResponseOnce(async () => Promise.resolve(buildResponse({ data })));
-            const parsedResponse = await caller.call('get');
+            const parsedResponse = await caller.call('GET');
 
             expect(parsedResponse).toStrictEqual({ data });
         });
@@ -247,7 +247,7 @@ describe('CallsApi', () => {
 
         it('should return undefined if the response from the handler is undefined', async () => {
             fetchMock.mockResponseOnce(async () => Promise.resolve(buildResponse(undefined, { status: 100 })));
-            await expect(caller.call('get')).resolves.toBeUndefined();
+            await expect(caller.call('GET')).resolves.toBeUndefined();
         });
 
         describe('requestMiddleware', () => {
@@ -313,7 +313,7 @@ describe('CallsApi', () => {
 
                 fetchMock.mockResponseOnce(async () => Promise.resolve(buildResponse(User.factory().raw())));
                 await caller.call(
-                    'post',
+                    'POST',
                     { key: 'value' },
                     { header: 'value' }
                 );
@@ -332,7 +332,7 @@ describe('CallsApi', () => {
 
                 fetchMock.mockResponseOnce(async () => Promise.resolve(buildResponse(User.factory().raw())));
                 await caller.call(
-                    'get',
+                    'GET',
                     { key: 'value' },
                     { header: 'value' }
                 );