Merge pull request #406 from Scalingo/feat/scm_orgs_pagination

feat(scm_orgs) : add pagination support

src/SCMIntegrations/index.ts

@@ -6,6 +6,7 @@ import {
   Repository,
   Organization,
   Branch,
+  OrganizationsMeta,
 } from "../models/auth/scm_integrations";
 import { CreateParams } from "../params/auth/scm_integrations";
 import { unpackData } from "../utils";
@@ -139,14 +140,21 @@ export default class SCMIntegrations {
    * Get list of organizations attached to an SCM integration account.
    * @see https://developers.scalingo.com/scm_integrations#
    * @param integrationID ID of the integration
+   * @param page Page number
+   * @param per_page Number of organizations per page
    * @return Promise that when resolved returns the list of organizations.
    */
-  organizations(integrationID: string): Promise<Organization[]> {
+  organizations(
+    integrationID: string,
+    page: number = 1,
+    per_page: number = 20,
+  ): Promise<{ organizations: Organization[]; meta: OrganizationsMeta }> {
     return unpackData(
       this._client
         .authApiClient()
-        .get(`/scm_integrations/${integrationID}/orgs`),
-      "organizations",
+        .get(`/scm_integrations/${integrationID}/orgs`, {
+          params: { page, per_page },
+        }),
     );
   }
 

src/models/auth/scm_integrations.ts

@@ -1,3 +1,5 @@
+import { PaginationMeta } from "src/meta";
+
 import { User } from "./user";
 
 /**
@@ -81,6 +83,10 @@ export interface Organization {
   url: string;
 }
 
+export interface OrganizationsMeta {
+  pagination: PaginationMeta;
+}
+
 /** @see https://developers.scalingo.com/scm_repo_link */
 export interface Branch {
   /** Name of the branch */

test/SCMIntegrations/index.test.js

@@ -93,7 +93,7 @@ describe("SCMIntegrations#organizations", () => {
   testGetter(
     "https://auth.scalingo.com/v1/scm_integrations/biniou/orgs",
     null,
-    "organizations",
+    null,
     (client) => {
       return new SCMIntegrations(client).organizations("biniou");
     },