@rippling/rippling-sdk 0.2.0-alpha.27 → 0.2.0-alpha.29

package/src/resources/location-factors.ts

@@ -21,7 +21,7 @@ export class LocationFactors extends APIResource {
     query: LocationFactorListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<LocationFactorListResponsesPageCursorURL, LocationFactorListResponse> {
-    return this._client.getAPIList('/location-factors', PageCursorURL<LocationFactorListResponse>, {
+    return this._client.getAPIList('/location-factors/', PageCursorURL<LocationFactorListResponse>, {
       query,
       ...options,
     });
@@ -31,7 +31,7 @@ export class LocationFactors extends APIResource {
    * Retrieve a specific location factor
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<LocationFactorRetrieveResponse> {
-    return this._client.get(path`/location-factors/${id}`, options);
+    return this._client.get(path`/location-factors/${id}/`, options);
   }
 }
 

package/src/resources/metadata/components.ts

@@ -14,7 +14,7 @@ export class Components extends APIResource {
    * - Requires: `API Tier 1`
    */
   list(options?: RequestOptions): PagePromise<ComponentListResponsesPageCursorURL, ComponentListResponse> {
-    return this._client.getAPIList('/metadata/components', PageCursorURL<ComponentListResponse>, options);
+    return this._client.getAPIList('/metadata/components/', PageCursorURL<ComponentListResponse>, options);
   }
 }
 

package/src/resources/metadata/metadata.ts

@@ -24,7 +24,7 @@ export class Metadata extends APIResource {
    * - Requires: `API Tier 1`
    */
   list(options?: RequestOptions): PagePromise<MetadataListResponsesPageCursorURL, MetadataListResponse> {
-    return this._client.getAPIList('/metadata', PageCursorURL<MetadataListResponse>, options);
+    return this._client.getAPIList('/metadata/', PageCursorURL<MetadataListResponse>, options);
   }
 }
 

package/src/resources/metadata/summary.ts

@@ -14,7 +14,7 @@ export class Summary extends APIResource {
    * - Requires: `API Tier 1`
    */
   list(options?: RequestOptions): PagePromise<SummaryListResponsesPageCursorURL, SummaryListResponse> {
-    return this._client.getAPIList('/metadata/summary', PageCursorURL<SummaryListResponse>, options);
+    return this._client.getAPIList('/metadata/summary/', PageCursorURL<SummaryListResponse>, options);
   }
 }
 

package/src/resources/metadata/types.ts

@@ -14,7 +14,7 @@ export class Types extends APIResource {
    * - Requires: `API Tier 1`
    */
   list(options?: RequestOptions): PagePromise<TypeListResponsesPageCursorURL, TypeListResponse> {
-    return this._client.getAPIList('/metadata/types', PageCursorURL<TypeListResponse>, options);
+    return this._client.getAPIList('/metadata/types/', PageCursorURL<TypeListResponse>, options);
   }
 }
 

package/src/resources/platform-capabilities.ts

@@ -17,7 +17,7 @@ export class PlatformCapabilities extends APIResource {
     options?: RequestOptions,
   ): PagePromise<PlatformCapabilityListResponsesPageCursorURL, PlatformCapabilityListResponse> {
     return this._client.getAPIList(
-      '/platform-capabilities',
+      '/platform-capabilities/',
       PageCursorURL<PlatformCapabilityListResponse>,
       options,
     );

package/src/resources/report-runs.ts

@@ -14,14 +14,14 @@ export class ReportRuns extends APIResource {
    * Trigger a new report run
    */
   create(body: ReportRunCreateParams, options?: RequestOptions): APIPromise<ReportRunCreateResponse> {
-    return this._client.post('/report-runs', { body, ...options });
+    return this._client.post('/report-runs/', { body, ...options });
   }
 
   /**
    * Retrieve the status and data for a specific report run
    */
   retrieve(runID: string, options?: RequestOptions): APIPromise<ReportRunRetrieveResponse> {
-    return this._client.get(path`/report-runs/${runID}`, options);
+    return this._client.get(path`/report-runs/${runID}/`, options);
   }
 }
 

package/src/resources/run-query.ts

@@ -15,7 +15,7 @@ export class RunQuery extends APIResource {
    * server-side.
    */
   create(body: RunQueryCreateParams, options?: RequestOptions): APIPromise<RunQueryCreateResponse> {
-    return this._client.post('/run-query', { body, ...options });
+    return this._client.post('/run-query/', { body, ...options });
   }
 }
 

package/src/resources/schedules.ts

@@ -23,7 +23,7 @@ export class Schedules extends APIResource {
     query: ScheduleListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<ScheduleListResponsesPageCursorURL, ScheduleListResponse> {
-    return this._client.getAPIList('/schedules', PageCursorURL<ScheduleListResponse>, { query, ...options });
+    return this._client.getAPIList('/schedules/', PageCursorURL<ScheduleListResponse>, { query, ...options });
   }
 
   /**
@@ -33,7 +33,7 @@ export class Schedules extends APIResource {
     body: ScheduleCreateParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<ScheduleCreateResponse> {
-    return this._client.post('/schedules', { body, ...options });
+    return this._client.post('/schedules/', { body, ...options });
   }
 
   /**
@@ -44,7 +44,7 @@ export class Schedules extends APIResource {
     query: ScheduleRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<ScheduleRetrieveResponse> {
-    return this._client.get(path`/schedules/${id}`, { query, ...options });
+    return this._client.get(path`/schedules/${id}/`, { query, ...options });
   }
 
   /**
@@ -55,7 +55,7 @@ export class Schedules extends APIResource {
     body: ScheduleUpdateParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<ScheduleUpdateResponse> {
-    return this._client.patch(path`/schedules/${id}`, { body, ...options });
+    return this._client.patch(path`/schedules/${id}/`, { body, ...options });
   }
 }
 

package/src/resources/send-email.ts

@@ -9,10 +9,10 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class SendEmail extends APIResource {
   /**
-   * Send an email to the specified recipients with the given subject and body.
+   * Execute the email action.
    */
   create(body: SendEmailCreateParams, options?: RequestOptions): APIPromise<SendEmailCreateResponse> {
-    return this._client.post('/send-email', { body, ...options });
+    return this._client.post('/send-email/', { body, ...options });
   }
 }
 

package/src/resources/send-http-request.ts

@@ -0,0 +1,49 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Execute workflow actions like sending emails, Slack messages, and notifications
+ */
+export class SendHTTPRequest extends APIResource {
+  /**
+   * Execute the http request action.
+   */
+  create(
+    body: SendHTTPRequestCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<SendHTTPRequestCreateResponse> {
+    return this._client.post('/send-http-request/', { body, ...options });
+  }
+}
+
+export interface SendHTTPRequestCreateResponse {
+  /**
+   * Result of the send HTTP request action
+   */
+  result: unknown;
+}
+
+export interface SendHTTPRequestCreateParams {
+  url: string;
+
+  customHTTPHeaders?: unknown | null;
+
+  /**
+   * An enumeration.
+   */
+  method?: 'POST' | 'GET' | 'PUT' | 'PATCH' | 'DELETE' | null;
+
+  payload?: unknown | null;
+
+  queryParams?: unknown | null;
+}
+
+export declare namespace SendHTTPRequest {
+  export {
+    type SendHTTPRequestCreateResponse as SendHTTPRequestCreateResponse,
+    type SendHTTPRequestCreateParams as SendHTTPRequestCreateParams,
+  };
+}

package/src/resources/send-push-notification.ts

@@ -0,0 +1,42 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Execute workflow actions like sending emails, Slack messages, and notifications
+ */
+export class SendPushNotification extends APIResource {
+  /**
+   * Execute the push notification action.
+   */
+  create(
+    body: SendPushNotificationCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<SendPushNotificationCreateResponse> {
+    return this._client.post('/send-push-notification/', { body, ...options });
+  }
+}
+
+export interface SendPushNotificationCreateResponse {
+  /**
+   * Result of the send push notification action
+   */
+  result: unknown;
+}
+
+export interface SendPushNotificationCreateParams {
+  header: string;
+
+  message: string;
+
+  recipients: Array<string>;
+}
+
+export declare namespace SendPushNotification {
+  export {
+    type SendPushNotificationCreateResponse as SendPushNotificationCreateResponse,
+    type SendPushNotificationCreateParams as SendPushNotificationCreateParams,
+  };
+}

package/src/resources/send-report-sftp.ts

@@ -0,0 +1,66 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Execute workflow actions like sending emails, Slack messages, and notifications
+ */
+export class SendReportSftp extends APIResource {
+  /**
+   * Execute the sftp report action.
+   */
+  create(
+    body: SendReportSftpCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<SendReportSftpCreateResponse> {
+    return this._client.post('/send-report-sftp/', { body, ...options });
+  }
+}
+
+export interface SendReportSftpCreateResponse {
+  /**
+   * Result of the send report via SFTP action
+   */
+  result: unknown;
+}
+
+export interface SendReportSftpCreateParams {
+  /**
+   * An enumeration.
+   */
+  authenticationType: 'PASSWORD' | 'SSH_KEY';
+
+  fileType: string;
+
+  hostName: string;
+
+  port: number;
+
+  reportId: string;
+
+  userName: string;
+
+  fileName?: string | null;
+
+  filePath?: string | null;
+
+  /**
+   * An enumeration.
+   */
+  fileSuffix?: 'EPOCH_FORMAT' | 'NO_SUFFIX' | 'DEFAULT_FORMAT' | null;
+
+  password?: string | null;
+
+  privateKey?: string | null;
+
+  privateKeyPassphrase?: string | null;
+}
+
+export declare namespace SendReportSftp {
+  export {
+    type SendReportSftpCreateResponse as SendReportSftpCreateResponse,
+    type SendReportSftpCreateParams as SendReportSftpCreateParams,
+  };
+}

package/src/resources/send-slack.ts

@@ -9,10 +9,10 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class SendSlack extends APIResource {
   /**
-   * Send a Slack message to the specified recipients.
+   * Execute the slack message action.
    */
   create(body: SendSlackCreateParams, options?: RequestOptions): APIPromise<SendSlackCreateResponse> {
-    return this._client.post('/send-slack', { body, ...options });
+    return this._client.post('/send-slack/', { body, ...options });
   }
 }
 

package/src/resources/send-sms.ts

@@ -0,0 +1,37 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Execute workflow actions like sending emails, Slack messages, and notifications
+ */
+export class SendSMS extends APIResource {
+  /**
+   * Execute the sms action.
+   */
+  create(body: SendSMSCreateParams, options?: RequestOptions): APIPromise<SendSMSCreateResponse> {
+    return this._client.post('/send-sms/', { body, ...options });
+  }
+}
+
+export interface SendSMSCreateResponse {
+  /**
+   * Result of the send SMS action
+   */
+  result: unknown;
+}
+
+export interface SendSMSCreateParams {
+  message: string;
+
+  recipients: Array<string>;
+}
+
+export declare namespace SendSMS {
+  export {
+    type SendSMSCreateResponse as SendSMSCreateResponse,
+    type SendSMSCreateParams as SendSMSCreateParams,
+  };
+}

package/src/resources/send-survey.ts

@@ -0,0 +1,43 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Execute workflow actions like sending emails, Slack messages, and notifications
+ */
+export class SendSurvey extends APIResource {
+  /**
+   * Execute the survey action.
+   */
+  create(body: SendSurveyCreateParams, options?: RequestOptions): APIPromise<SendSurveyCreateResponse> {
+    return this._client.post('/send-survey/', { body, ...options });
+  }
+}
+
+export interface SendSurveyCreateResponse {
+  /**
+   * Result of the send survey action
+   */
+  result: unknown;
+}
+
+export interface SendSurveyCreateParams {
+  body: string;
+
+  recipients: Array<string>;
+
+  subject: string;
+
+  surveyID: string;
+
+  expiryDays?: number | null;
+}
+
+export declare namespace SendSurvey {
+  export {
+    type SendSurveyCreateResponse as SendSurveyCreateResponse,
+    type SendSurveyCreateParams as SendSurveyCreateParams,
+  };
+}

package/src/resources/send-teams.ts

@@ -0,0 +1,42 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Execute workflow actions like sending emails, Slack messages, and notifications
+ */
+export class SendTeams extends APIResource {
+  /**
+   * Execute the teams message action.
+   */
+  create(body: SendTeamCreateParams, options?: RequestOptions): APIPromise<SendTeamCreateResponse> {
+    return this._client.post('/send-teams/', { body, ...options });
+  }
+}
+
+export interface SendTeamCreateResponse {
+  /**
+   * Result of the send Teams message action
+   */
+  result: unknown;
+}
+
+export interface SendTeamCreateParams {
+  /**
+   * An enumeration.
+   */
+  action_type: 'PUBLIC_CHANNEL_MESSAGE' | 'SINGLE_DIRECT_MESSAGE';
+
+  message: string;
+
+  recipients?: Array<string> | null;
+}
+
+export declare namespace SendTeams {
+  export {
+    type SendTeamCreateResponse as SendTeamCreateResponse,
+    type SendTeamCreateParams as SendTeamCreateParams,
+  };
+}

package/src/resources/shift-assignments.ts

@@ -28,7 +28,7 @@ export class ShiftAssignments extends APIResource {
     body: ShiftAssignmentUpdateCustomfieldsParams,
     options?: RequestOptions,
   ): APIPromise<ShiftAssignmentUpdateCustomfieldsResponse> {
-    return this._client.patch(path`/shiftassignments/${id}/customfields`, { body, ...options });
+    return this._client.patch(path`/shiftassignments/${id}/customfields/`, { body, ...options });
   }
 }
 

package/src/resources/shift-inputs.ts

@@ -25,7 +25,7 @@ export class ShiftInputs extends APIResource {
     query: ShiftInputListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<ShiftInputListResponsesPageCursorURL, ShiftInputListResponse> {
-    return this._client.getAPIList('/shift-inputs', PageCursorURL<ShiftInputListResponse>, {
+    return this._client.getAPIList('/shift-inputs/', PageCursorURL<ShiftInputListResponse>, {
       query,
       ...options,
     });
@@ -35,7 +35,7 @@ export class ShiftInputs extends APIResource {
    * Create a new shift input
    */
   create(body: ShiftInputCreateParams, options?: RequestOptions): APIPromise<ShiftInputCreateResponse> {
-    return this._client.post('/shift-inputs', { body, ...options });
+    return this._client.post('/shift-inputs/', { body, ...options });
   }
 
   /**
@@ -46,7 +46,7 @@ export class ShiftInputs extends APIResource {
     query: ShiftInputRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<ShiftInputRetrieveResponse> {
-    return this._client.get(path`/shift-inputs/${id}`, { query, ...options });
+    return this._client.get(path`/shift-inputs/${id}/`, { query, ...options });
   }
 
   /**
@@ -57,14 +57,14 @@ export class ShiftInputs extends APIResource {
     body: ShiftInputUpdateParams,
     options?: RequestOptions,
   ): APIPromise<ShiftInputUpdateResponse> {
-    return this._client.patch(path`/shift-inputs/${id}`, { body, ...options });
+    return this._client.patch(path`/shift-inputs/${id}/`, { body, ...options });
   }
 
   /**
    * Delete a shift input
    */
   delete(id: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/shift-inputs/${id}`, {
+    return this._client.delete(path`/shift-inputs/${id}/`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });

package/src/resources/shiftassignments.ts

@@ -25,7 +25,7 @@ export class Shiftassignments extends APIResource {
     query: ShiftassignmentListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<ShiftassignmentListResponsesPageCursorURL, ShiftassignmentListResponse> {
-    return this._client.getAPIList('/shiftassignments', PageCursorURL<ShiftassignmentListResponse>, {
+    return this._client.getAPIList('/shiftassignments/', PageCursorURL<ShiftassignmentListResponse>, {
       query,
       ...options,
     });
@@ -38,7 +38,7 @@ export class Shiftassignments extends APIResource {
     body: ShiftassignmentCreateParams,
     options?: RequestOptions,
   ): APIPromise<ShiftassignmentCreateResponse> {
-    return this._client.post('/shiftassignments', { body, ...options });
+    return this._client.post('/shiftassignments/', { body, ...options });
   }
 
   /**
@@ -49,7 +49,7 @@ export class Shiftassignments extends APIResource {
     query: ShiftassignmentRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<ShiftassignmentRetrieveResponse> {
-    return this._client.get(path`/shiftassignments/${id}`, { query, ...options });
+    return this._client.get(path`/shiftassignments/${id}/`, { query, ...options });
   }
 
   /**
@@ -60,7 +60,7 @@ export class Shiftassignments extends APIResource {
     body: ShiftassignmentUpdateParams,
     options?: RequestOptions,
   ): APIPromise<ShiftassignmentUpdateResponse> {
-    return this._client.patch(path`/shiftassignments/${id}`, { body, ...options });
+    return this._client.patch(path`/shiftassignments/${id}/`, { body, ...options });
   }
 }
 

package/src/resources/sso-me.ts

@@ -15,8 +15,8 @@ export class SSOMeResource extends APIResource {
    * - Requires: `API Tier 1`
    * - Expandable fields: `company`
    */
-  retrieve(query: SSOMeRetrieveParams | null | undefined = {}, options?: RequestOptions): APIPromise<SSOMe> {
-    return this._client.get('/sso-me', { query, ...options });
+  list(query: SSOMeListParams | null | undefined = {}, options?: RequestOptions): APIPromise<SSOMe> {
+    return this._client.get('/sso-me/', { query, ...options });
   }
 }
 
@@ -54,12 +54,12 @@ export interface SSOMe {
   work_email?: string;
 }
 
-export interface SSOMeRetrieveParams {
+export interface SSOMeListParams {
   cursor?: string;
 
   expand?: string;
 }
 
 export declare namespace SSOMeResource {
-  export { type SSOMe as SSOMe, type SSOMeRetrieveParams as SSOMeRetrieveParams };
+  export { type SSOMe as SSOMe, type SSOMeListParams as SSOMeListParams };
 }

package/src/resources/supergroups/exclusion-members.ts

@@ -25,7 +25,7 @@ export class ExclusionMembers extends APIResource {
     options?: RequestOptions,
   ): PagePromise<GroupMembersPageCursorURL, Shared.GroupMember> {
     return this._client.getAPIList(
-      path`/supergroups/${groupID}/exclusion-members`,
+      path`/supergroups/${groupID}/exclusion-members/`,
       PageCursorURL<Shared.GroupMember>,
       { query, ...options },
     );
@@ -39,7 +39,7 @@ export class ExclusionMembers extends APIResource {
     body: ExclusionMemberUpdateParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<ExclusionMemberUpdateResponse> {
-    return this._client.patch(path`/supergroups/${groupID}/exclusion-members`, { body, ...options });
+    return this._client.patch(path`/supergroups/${groupID}/exclusion-members/`, { body, ...options });
   }
 }
 

package/src/resources/supergroups/inclusion-members.ts

@@ -25,7 +25,7 @@ export class InclusionMembers extends APIResource {
     options?: RequestOptions,
   ): PagePromise<GroupMembersPageCursorURL, Shared.GroupMember> {
     return this._client.getAPIList(
-      path`/supergroups/${groupID}/inclusion-members`,
+      path`/supergroups/${groupID}/inclusion-members/`,
       PageCursorURL<Shared.GroupMember>,
       { query, ...options },
     );
@@ -39,7 +39,7 @@ export class InclusionMembers extends APIResource {
     body: InclusionMemberUpdateParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<InclusionMemberUpdateResponse> {
-    return this._client.patch(path`/supergroups/${groupID}/inclusion-members`, { body, ...options });
+    return this._client.patch(path`/supergroups/${groupID}/inclusion-members/`, { body, ...options });
   }
 }
 

package/src/resources/supergroups/members.ts

@@ -23,10 +23,11 @@ export class Members extends APIResource {
     query: MemberListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<GroupMembersPageCursorURL, Shared.GroupMember> {
-    return this._client.getAPIList(path`/supergroups/${groupID}/members`, PageCursorURL<Shared.GroupMember>, {
-      query,
-      ...options,
-    });
+    return this._client.getAPIList(
+      path`/supergroups/${groupID}/members/`,
+      PageCursorURL<Shared.GroupMember>,
+      { query, ...options },
+    );
   }
 }
 

package/src/resources/supergroups/supergroups.ts

@@ -46,14 +46,14 @@ export class Supergroups extends APIResource {
     query: SupergroupListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<SupergroupsPageCursorURL, Supergroup> {
-    return this._client.getAPIList('/supergroups', PageCursorURL<Supergroup>, { query, ...options });
+    return this._client.getAPIList('/supergroups/', PageCursorURL<Supergroup>, { query, ...options });
   }
 
   /**
    * Retrieve a specific supergroup.
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<SupergroupRetrieveResponse> {
-    return this._client.get(path`/supergroups/${id}`, options);
+    return this._client.get(path`/supergroups/${id}/`, options);
   }
 }
 

package/src/resources/teams.ts

@@ -22,7 +22,7 @@ export class Teams extends APIResource {
     query: TeamListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<TeamsPageCursorURL, Team> {
-    return this._client.getAPIList('/teams', PageCursorURL<Team>, { query, ...options });
+    return this._client.getAPIList('/teams/', PageCursorURL<Team>, { query, ...options });
   }
 
   /**
@@ -33,7 +33,7 @@ export class Teams extends APIResource {
     query: TeamRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<TeamRetrieveResponse> {
-    return this._client.get(path`/teams/${id}`, { query, ...options });
+    return this._client.get(path`/teams/${id}/`, { query, ...options });
   }
 }