camara-sdk 0.1.1

package/src/resources/tenure.ts

@@ -0,0 +1,78 @@
+// 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 { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+
+export class Tenure extends APIResource {
+  /**
+   * Verifies a specified length of tenure, based on a provided date, for a network
+   * subscriber to establish a level of trust for the network subscription
+   * identifier.
+   *
+   * @example
+   * ```ts
+   * const response = await client.tenure.verify({
+   *   tenureDate: '2023-07-03',
+   * });
+   * ```
+   */
+  verify(params: TenureVerifyParams, options?: RequestOptions): APIPromise<TenureVerifyResponse> {
+    const { 'x-correlator': xCorrelator, ...body } = params;
+    return this._client.post('/tenure/check-tenure', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        { ...(xCorrelator != null ? { 'x-correlator': xCorrelator } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface TenureVerifyResponse {
+  /**
+   * `true` when the identified mobile subscription has had valid tenure since
+   * `tenureDate`, otherwise `false`
+   */
+  tenureDateCheck: boolean;
+
+  /**
+   * If exists, populated with:
+   *
+   * - `PAYG` - prepaid (pay-as-you-go) account
+   * - `PAYM` - contract account
+   * - `Business` - Business (enterprise) account
+   *
+   * This attribute may be omitted from the response set if the information is not
+   * available
+   */
+  contractType?: 'PAYG' | 'PAYM' | 'Business';
+}
+
+export interface TenureVerifyParams {
+  /**
+   * Body param: The date, in RFC 3339 / ISO 8601 compliant format "YYYY-MM-DD", from
+   * which continuous tenure of the identified network subscriber is required to be
+   * confirmed
+   */
+  tenureDate: string;
+
+  /**
+   * Body param: A public identifier addressing a telephone subscription. In mobile
+   * networks it corresponds to the MSISDN (Mobile Station International Subscriber
+   * Directory Number). In order to be globally unique it has to be formatted in
+   * international format, according to E.164 standard, prefixed with '+'.
+   */
+  phoneNumber?: string;
+
+  /**
+   * Header param: Correlation id for the different services
+   */
+  'x-correlator'?: string;
+}
+
+export declare namespace Tenure {
+  export { type TenureVerifyResponse as TenureVerifyResponse, type TenureVerifyParams as TenureVerifyParams };
+}

package/src/resources/webrtc/index.ts

@@ -0,0 +1,12 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Sessions,
+  type MediaSessionInformation,
+  type SdpDescriptor,
+  type SessionCreateParams,
+  type SessionRetrieveParams,
+  type SessionDeleteParams,
+  type SessionUpdateStatusParams,
+} from './sessions';
+export { Webrtc } from './webrtc';

package/src/resources/webrtc/sessions.ts

@@ -0,0 +1,519 @@
+// 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 { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Sessions extends APIResource {
+  /**
+   * Creates a voice and/or video session
+   *
+   * @example
+   * ```ts
+   * const mediaSessionInformation =
+   *   await client.webrtc.sessions.create({
+   *     registrationId: 'registrationId',
+   *     clientCorrelator:
+   *       'fda6e26d-e7c8-4596-870c-c083c0d39b2c',
+   *     offer: {
+   *       sdp: 'v=0\r\no=- 8066321617929821805 2 IN IP4 127.0.0.1\r\ns=-\r\nt=0 0\r\nm=audio 42988 RTP/SAVPF 102 113\r\nc=IN IP6 2001:e0:410:2448:7a05:9b11:66f2:c9e\r\nb=AS:64\r\na=rtcp:9 IN IP4 0.0.0.0\r\na=candidate:1645903805 1 udp 2122262783 2001:e0:410:2448:7a05:9b11:66f2:c9e 42988 typ host generation 0 network-id 3 network-cost 900\r\na=ice-ufrag:4eKp\r\na=ice-pwd:D4sF5Pv9vx9ggaqxBlHbAFMx\r\na=ice-options:trickle renomination\r\na=mid:audio\r\na=extmap:2 http://www.ietf.org/id/draft-holmer-rmcat-transport-wide-cc-extensions-01\r\na=sendrecv\r\na=rtcp-mux\r\na=crypto:1 AES_CM_128_HMAC_SHA1_80 inline:Xm3YciqVIWFNSwy19e9MvfZ2YOdAZil7oT/tHjdf\r\na=rtpmap:102 AMR-WB/16000\r\na=fmtp:102 octet-align=0; mode-set=0,1,2; mode-change-capability=2\r\na=rtpmap:113 telephone-event/16000\r\n',
+   *     },
+   *     originatorAddress: 'tel:+17085852753',
+   *     originatorName: 'tel:+17085852753',
+   *     receiverAddress: 'tel:+17085854000',
+   *     receiverName: 'tel:+17085854000',
+   *   });
+   * ```
+   */
+  create(params: SessionCreateParams, options?: RequestOptions): APIPromise<MediaSessionInformation> {
+    const { registrationId, 'x-correlator': xCorrelator, ...body } = params;
+    return this._client.post('/webrtc/sessions', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          registrationId: registrationId,
+          ...(xCorrelator != null ? { 'x-correlator': xCorrelator } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Get the media Session description based on `mediaSessionId`.
+   *
+   * ** The client shall construct the API path using the `mediaSessionId` supplied
+   * in the session creation response (origination) or in the invitation notification
+   * (termination). **
+   *
+   * @example
+   * ```ts
+   * const mediaSessionInformation =
+   *   await client.webrtc.sessions.retrieve('mediaSessionId');
+   * ```
+   */
+  retrieve(
+    mediaSessionID: string,
+    params: SessionRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<MediaSessionInformation> {
+    const { 'x-correlator': xCorrelator } = params ?? {};
+    return this._client.get(path`/webrtc/sessions/${mediaSessionID}`, {
+      ...options,
+      headers: buildHeaders([
+        { ...(xCorrelator != null ? { 'x-correlator': xCorrelator } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Cancel a 1-1 media session (as originator), Decline a 1-1 media session (as
+   * receiver), Terminate a 1-1 an ongoing media session ** The client shall
+   * construct the API path using the mediaSessionId supplied in the session creation
+   * response (origination) or in the invitation notification (termination). **'
+   *
+   * @example
+   * ```ts
+   * await client.webrtc.sessions.delete('mediaSessionId');
+   * ```
+   */
+  delete(
+    mediaSessionID: string,
+    params: SessionDeleteParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    const { 'x-correlator': xCorrelator } = params ?? {};
+    return this._client.delete(path`/webrtc/sessions/${mediaSessionID}`, {
+      ...options,
+      headers: buildHeaders([
+        { Accept: '*/*', ...(xCorrelator != null ? { 'x-correlator': xCorrelator } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Update the status of the media session, this may include updating SDP media
+   *
+   * The API consumer shall construct the API path using the `mediaSessionId`
+   * supplied in the session creation response (origination) or in the invitation
+   * notification (termination).
+   *
+   * @example
+   * ```ts
+   * const mediaSessionInformation =
+   *   await client.webrtc.sessions.updateStatus(
+   *     'mediaSessionId',
+   *   );
+   * ```
+   */
+  updateStatus(
+    mediaSessionID: string,
+    params: SessionUpdateStatusParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<MediaSessionInformation> {
+    const { 'x-correlator': xCorrelator, ...body } = params ?? {};
+    return this._client.put(path`/webrtc/sessions/${mediaSessionID}/status`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        { ...(xCorrelator != null ? { 'x-correlator': xCorrelator } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface MediaSessionInformation {
+  /**
+   * **OFFER**: An inlined session description in SDP format [RFC4566].If XML syntax
+   * is used, the content of this element SHALL be embedded in a CDATA section.
+   *
+   * **ANSWER**: This type represents an answer in WebRTC Signaling. This element is
+   * not present in case there is no answer yet, or the session invitation has been
+   * declined by the Terminating Participant.This element MUST NOT be present in a
+   * request from the application to the server to create a session.
+   */
+  answer?: SdpDescriptor;
+
+  /**
+   * The reference to the call object
+   */
+  callObjectRef?: string;
+
+  /**
+   * A correlator that the client can use to tag this particular resource
+   * representation during a request to create a resource on the server. Note - This
+   * allows the client to recover from communication failures during resource
+   * creation and therefore avoids re-sending the message in such situations. In case
+   * the element is present, the WebRTC GW shall not alter its value, and shall
+   * provide it as part of the representation of this resource.
+   */
+  clientCorrelator?: string;
+
+  /**
+   * The media session ID created by the network. The mediaSessionId shall not be
+   * included in POST requests by the client, but must be included in the
+   * notifications from the network to the client device.
+   */
+  mediaSessionId?: string;
+
+  /**
+   * **OFFER**: An inlined session description in SDP format [RFC4566].If XML syntax
+   * is used, the content of this element SHALL be embedded in a CDATA section.
+   *
+   * **ANSWER**: This type represents an answer in WebRTC Signaling. This element is
+   * not present in case there is no answer yet, or the session invitation has been
+   * declined by the Terminating Participant.This element MUST NOT be present in a
+   * request from the application to the server to create a session.
+   */
+  offer?: SdpDescriptor;
+
+  /**
+   * This element shall be included and set to true, if the session updates are
+   * received without SDP offer. This element indicates clients to send the offer.
+   */
+  offerRequired?: boolean;
+
+  /**
+   * Subscriber address (Sender or Receiver)
+   */
+  originatorAddress?: string;
+
+  /**
+   * Friendly name of the call originator
+   */
+  originatorName?: string;
+
+  /**
+   * The description of the event that has happened within the session
+   */
+  reason?: string;
+
+  /**
+   * Subscriber address (Sender or Receiver)
+   */
+  receiverAddress?: string;
+
+  /**
+   * Friendly name of the call terminator
+   */
+  receiverName?: string;
+
+  /**
+   * The sequence number of the notification sent to client
+   */
+  sequenceNumber?: number;
+
+  /**
+   * A correlator that the server instructs the client to use for end to end
+   * correlation.
+   */
+  serverCorrelator?: string;
+
+  /**
+   * Provides the status of the media session. During the session creation, this
+   * attribute SHALL NOT be included in the request.
+   */
+  status?:
+    | 'Initial'
+    | 'InProgress'
+    | 'Ringing'
+    | 'Proceeding'
+    | 'Connected'
+    | 'Terminated'
+    | 'Hold'
+    | 'Resume'
+    | 'SessionCancelled'
+    | 'Declined'
+    | 'Failed'
+    | 'Waiting'
+    | 'NoAnswer'
+    | 'NotReachable'
+    | 'Busy';
+}
+
+/**
+ * **OFFER**: An inlined session description in SDP format [RFC4566].If XML syntax
+ * is used, the content of this element SHALL be embedded in a CDATA section.
+ *
+ * **ANSWER**: This type represents an answer in WebRTC Signaling. This element is
+ * not present in case there is no answer yet, or the session invitation has been
+ * declined by the Terminating Participant.This element MUST NOT be present in a
+ * request from the application to the server to create a session.
+ */
+export interface SdpDescriptor {
+  /**
+   * An inlined session description in SDP format [RFC4566].If XML syntax is used,
+   * the content of this element SHALL be embedded in a CDATA section
+   */
+  sdp?: string;
+}
+
+export interface SessionCreateParams {
+  /**
+   * Header param: The device registration identifier assigned by the network
+   */
+  registrationId: string;
+
+  /**
+   * Body param: **OFFER**: An inlined session description in SDP format [RFC4566].If
+   * XML syntax is used, the content of this element SHALL be embedded in a CDATA
+   * section.
+   *
+   * **ANSWER**: This type represents an answer in WebRTC Signaling. This element is
+   * not present in case there is no answer yet, or the session invitation has been
+   * declined by the Terminating Participant.This element MUST NOT be present in a
+   * request from the application to the server to create a session.
+   */
+  answer?: SdpDescriptor;
+
+  /**
+   * Body param: The reference to the call object
+   */
+  callObjectRef?: string;
+
+  /**
+   * Body param: A correlator that the client can use to tag this particular resource
+   * representation during a request to create a resource on the server. Note - This
+   * allows the client to recover from communication failures during resource
+   * creation and therefore avoids re-sending the message in such situations. In case
+   * the element is present, the WebRTC GW shall not alter its value, and shall
+   * provide it as part of the representation of this resource.
+   */
+  clientCorrelator?: string;
+
+  /**
+   * Body param: The media session ID created by the network. The mediaSessionId
+   * shall not be included in POST requests by the client, but must be included in
+   * the notifications from the network to the client device.
+   */
+  mediaSessionId?: string;
+
+  /**
+   * Body param: **OFFER**: An inlined session description in SDP format [RFC4566].If
+   * XML syntax is used, the content of this element SHALL be embedded in a CDATA
+   * section.
+   *
+   * **ANSWER**: This type represents an answer in WebRTC Signaling. This element is
+   * not present in case there is no answer yet, or the session invitation has been
+   * declined by the Terminating Participant.This element MUST NOT be present in a
+   * request from the application to the server to create a session.
+   */
+  offer?: SdpDescriptor;
+
+  /**
+   * Body param: This element shall be included and set to true, if the session
+   * updates are received without SDP offer. This element indicates clients to send
+   * the offer.
+   */
+  offerRequired?: boolean;
+
+  /**
+   * Body param: Subscriber address (Sender or Receiver)
+   */
+  originatorAddress?: string;
+
+  /**
+   * Body param: Friendly name of the call originator
+   */
+  originatorName?: string;
+
+  /**
+   * Body param: The description of the event that has happened within the session
+   */
+  reason?: string;
+
+  /**
+   * Body param: Subscriber address (Sender or Receiver)
+   */
+  receiverAddress?: string;
+
+  /**
+   * Body param: Friendly name of the call terminator
+   */
+  receiverName?: string;
+
+  /**
+   * Body param: The sequence number of the notification sent to client
+   */
+  sequenceNumber?: number;
+
+  /**
+   * Body param: A correlator that the server instructs the client to use for end to
+   * end correlation.
+   */
+  serverCorrelator?: string;
+
+  /**
+   * Body param: Provides the status of the media session. During the session
+   * creation, this attribute SHALL NOT be included in the request.
+   */
+  status?:
+    | 'Initial'
+    | 'InProgress'
+    | 'Ringing'
+    | 'Proceeding'
+    | 'Connected'
+    | 'Terminated'
+    | 'Hold'
+    | 'Resume'
+    | 'SessionCancelled'
+    | 'Declined'
+    | 'Failed'
+    | 'Waiting'
+    | 'NoAnswer'
+    | 'NotReachable'
+    | 'Busy';
+
+  /**
+   * Header param: Correlation id for the different services
+   */
+  'x-correlator'?: string;
+}
+
+export interface SessionRetrieveParams {
+  /**
+   * Correlation id for the different services
+   */
+  'x-correlator'?: string;
+}
+
+export interface SessionDeleteParams {
+  /**
+   * Correlation id for the different services
+   */
+  'x-correlator'?: string;
+}
+
+export interface SessionUpdateStatusParams {
+  /**
+   * Body param: **OFFER**: An inlined session description in SDP format [RFC4566].If
+   * XML syntax is used, the content of this element SHALL be embedded in a CDATA
+   * section.
+   *
+   * **ANSWER**: This type represents an answer in WebRTC Signaling. This element is
+   * not present in case there is no answer yet, or the session invitation has been
+   * declined by the Terminating Participant.This element MUST NOT be present in a
+   * request from the application to the server to create a session.
+   */
+  answer?: SdpDescriptor;
+
+  /**
+   * Body param: The reference to the call object
+   */
+  callObjectRef?: string;
+
+  /**
+   * Body param: A correlator that the client can use to tag this particular resource
+   * representation during a request to create a resource on the server. Note - This
+   * allows the client to recover from communication failures during resource
+   * creation and therefore avoids re-sending the message in such situations. In case
+   * the element is present, the WebRTC GW shall not alter its value, and shall
+   * provide it as part of the representation of this resource.
+   */
+  clientCorrelator?: string;
+
+  /**
+   * Body param: The media session ID created by the network. The mediaSessionId
+   * shall not be included in POST requests by the client, but must be included in
+   * the notifications from the network to the client device.
+   */
+  body_mediaSessionId?: string;
+
+  /**
+   * Body param: **OFFER**: An inlined session description in SDP format [RFC4566].If
+   * XML syntax is used, the content of this element SHALL be embedded in a CDATA
+   * section.
+   *
+   * **ANSWER**: This type represents an answer in WebRTC Signaling. This element is
+   * not present in case there is no answer yet, or the session invitation has been
+   * declined by the Terminating Participant.This element MUST NOT be present in a
+   * request from the application to the server to create a session.
+   */
+  offer?: SdpDescriptor;
+
+  /**
+   * Body param: This element shall be included and set to true, if the session
+   * updates are received without SDP offer. This element indicates clients to send
+   * the offer.
+   */
+  offerRequired?: boolean;
+
+  /**
+   * Body param: Subscriber address (Sender or Receiver)
+   */
+  originatorAddress?: string;
+
+  /**
+   * Body param: Friendly name of the call originator
+   */
+  originatorName?: string;
+
+  /**
+   * Body param: The description of the event that has happened within the session
+   */
+  reason?: string;
+
+  /**
+   * Body param: Subscriber address (Sender or Receiver)
+   */
+  receiverAddress?: string;
+
+  /**
+   * Body param: Friendly name of the call terminator
+   */
+  receiverName?: string;
+
+  /**
+   * Body param: The sequence number of the notification sent to client
+   */
+  sequenceNumber?: number;
+
+  /**
+   * Body param: A correlator that the server instructs the client to use for end to
+   * end correlation.
+   */
+  serverCorrelator?: string;
+
+  /**
+   * Body param: Provides the status of the media session. During the session
+   * creation, this attribute SHALL NOT be included in the request.
+   */
+  status?:
+    | 'Initial'
+    | 'InProgress'
+    | 'Ringing'
+    | 'Proceeding'
+    | 'Connected'
+    | 'Terminated'
+    | 'Hold'
+    | 'Resume'
+    | 'SessionCancelled'
+    | 'Declined'
+    | 'Failed'
+    | 'Waiting'
+    | 'NoAnswer'
+    | 'NotReachable'
+    | 'Busy';
+
+  /**
+   * Header param: Correlation id for the different services
+   */
+  'x-correlator'?: string;
+}
+
+export declare namespace Sessions {
+  export {
+    type MediaSessionInformation as MediaSessionInformation,
+    type SdpDescriptor as SdpDescriptor,
+    type SessionCreateParams as SessionCreateParams,
+    type SessionRetrieveParams as SessionRetrieveParams,
+    type SessionDeleteParams as SessionDeleteParams,
+    type SessionUpdateStatusParams as SessionUpdateStatusParams,
+  };
+}

package/src/resources/webrtc/webrtc.ts

@@ -0,0 +1,31 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as SessionsAPI from './sessions';
+import {
+  MediaSessionInformation,
+  SdpDescriptor,
+  SessionCreateParams,
+  SessionDeleteParams,
+  SessionRetrieveParams,
+  SessionUpdateStatusParams,
+  Sessions,
+} from './sessions';
+
+export class Webrtc extends APIResource {
+  sessions: SessionsAPI.Sessions = new SessionsAPI.Sessions(this._client);
+}
+
+Webrtc.Sessions = Sessions;
+
+export declare namespace Webrtc {
+  export {
+    Sessions as Sessions,
+    type MediaSessionInformation as MediaSessionInformation,
+    type SdpDescriptor as SdpDescriptor,
+    type SessionCreateParams as SessionCreateParams,
+    type SessionRetrieveParams as SessionRetrieveParams,
+    type SessionDeleteParams as SessionDeleteParams,
+    type SessionUpdateStatusParams as SessionUpdateStatusParams,
+  };
+}

package/src/resources/webrtc.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './webrtc/index';

package/src/resources.ts

@@ -0,0 +1 @@
+export * from './resources/index';

package/src/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  // this config is included in the published src directory to prevent TS errors
+  // from appearing when users go to source, and VSCode opens the source .ts file
+  // via declaration maps
+  "include": ["index.ts"],
+  "compilerOptions": {
+    "target": "ES2015",
+    "lib": ["DOM", "DOM.Iterable", "ES2018"],
+    "moduleResolution": "node"
+  }
+}

package/src/uploads.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/uploads instead */
+export * from './core/uploads';

package/src/version.ts

@@ -0,0 +1 @@
+export const VERSION = '0.1.1'; // x-release-please-version

package/uploads.d.mts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.d.mts.map

package/uploads.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/uploads.d.ts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.js";
+//# sourceMappingURL=uploads.d.ts.map

package/uploads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/uploads.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("./internal/tslib.js");
+/** @deprecated Import from ./core/uploads instead */
+tslib_1.__exportStar(require("./core/uploads.js"), exports);
+//# sourceMappingURL=uploads.js.map

package/uploads.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.js","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":";;;AAAA,qDAAqD;AACrD,4DAA+B"}