@chilkat/react-native 11.6.1

package/src/specs/OAuth1.nitro.ts

@@ -0,0 +1,331 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+import type { PrivateKey } from './PrivateKey.nitro'
+
+/**
+ * Generate OAuth 1.0 signatures, authorization headers, and signed request URLs.
+ *
+ * `OAuth1` builds the signed OAuth 1.0 authentication data
+ * needed for APIs that still require OAuth 1.0 request signing. It can generate
+ * the signature base string, HMAC key, signature, URL-encoded signature,
+ * normalized signed parameter string, Authorization header, and generated URL
+ * containing OAuth query parameters. It supports consumer credentials, access
+ * tokens, nonce and timestamp generation, extra signed parameters, optional
+ * realm handling, HMAC-SHA1, HMAC-SHA256, RSA-SHA1, and RSA-SHA256 signing.
+ *
+ * **OAuth 1.0 signing**
+ *
+ * Generate the OAuth 1.0 signature and related authentication values from
+ * the HTTP method, request URL, credentials, token, nonce, and timestamp.
+ *
+ * **Authorization header**
+ *
+ * Produce the value to send in the HTTP `Authorization` header
+ * when OAuth parameters should be supplied as a header.
+ *
+ * **Signed URL output**
+ *
+ * Generate a URL that includes the OAuth 1.0 query parameters when the API
+ * expects authentication data in the request URL.
+ *
+ * **Extra signed parameters**
+ *
+ * Add or remove request-specific name/value parameters that must be
+ * included in the normalized parameter string and signature calculation.
+ *
+ * **HMAC or RSA signatures**
+ *
+ * Sign with `HMAC-SHA1`, `HMAC-SHA256`,
+ * `RSA-SHA1`, or `RSA-SHA256`, with RSA private keys
+ * supplied by `SetRsaKey`.
+ *
+ * **Debuggable signing details**
+ *
+ * Inspect the exact `BaseString`, `HmacKey`,
+ * `QueryString`, `Signature`, and
+ * `EncodedSignature` used to build the OAuth request.
+ *
+ * **Common pattern:**
+ * Set `OauthMethod` and `OauthUrl`, provide the consumer
+ * key and secret, set any token and token secret, generate or assign
+ * `Nonce` and `Timestamp`, add request parameters with
+ * `AddParam`, then call `Generate`. Use
+ * `AuthorizationHeader` when sending OAuth data in an HTTP header, or
+ * `GeneratedUrl` when the signed OAuth parameters should be placed
+ * in the URL.
+ *
+ * **URL guidance:**
+ * Set `OauthUrl` to the base request URL without query parameters.
+ * Add query parameters separately with `AddParam` so they are
+ * included correctly in the OAuth 1.0 signature calculation.
+ *
+ * Each `OAuth1` instance owns a native Chilkat object. It is released when the JavaScript object is
+ * garbage collected, or immediately by `dispose()`; any use after `dispose()` throws.
+ * Create one with `new OAuth1()`.
+ */
+export interface OAuth1 extends HybridObject<{ ios: 'c++', android: 'c++' }> {
+  // ---- Properties ----
+
+  /**
+   * Provides HTML-formatted information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorHtml: string
+
+  /**
+   * Provides plain text information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorText: string
+
+  /**
+   * Provides XML-formatted information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorXml: string
+
+  /**
+   * Version of the component/library, such as "10.1.0"
+   *
+   * This property is read-only.
+   */
+  readonly version: string
+
+  /**
+   * If set to a file path, this property logs the LastErrorText of each Chilkat method or property
+   * call to the specified file. This logging helps identify the context and history of Chilkat
+   * calls leading up to any crash or hang, aiding in debugging.
+   *
+   * Enabling the VerboseLogging property provides more detailed information.
+   *
+   * This property is mainly used for debugging rare instances where a Chilkat method call causes a
+   * hang or crash, which should generally not happen.
+   *
+   * Possible causes of hangs include:
+   *
+   * - A timeout property set to 0, indicating an infinite timeout.
+   *
+   * - A hang occurring within an event callback in the application code.
+   *
+   * - An internal bug in the Chilkat code causing the hang.
+   */
+  debugLogFilePath: string
+
+  /**
+   * If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may
+   * contain more verbose information. The default value is `false`. Verbose logging should only be
+   * used for debugging. The potentially large quantity of logged information may adversely affect
+   * peformance.
+   */
+  verboseLogging: boolean
+
+  /**
+   * Indicates the success or failure of the most recent method call: `true` means success, `false`
+   * means failure. This property remains unchanged by property setters or getters. This method is
+   * present to address challenges in checking for null or Nothing returns in certain programming
+   * languages. Note: This property does not apply to methods that return integer values or to
+   * boolean-returning methods where the boolean does not indicate success or failure.
+   */
+  lastMethodSuccess: boolean
+
+  /**
+   * The authorization header. This is what would be included in the Authorization HTTP request
+   * header if it is going to be used as the means for providing the OAuth1 authorization
+   * information.
+   *
+   * This property is read-only.
+   */
+  readonly authorizationHeader: string
+
+  /**
+   * This is the exact string that was signed. For example, if the signature method is HMAC-SHA1,
+   * the BaseString is the exact string that passed to the HMAC-SHA1. An application does not set
+   * the BaseString property. The BaseString is exposed as a property to allow for debugging and to
+   * see the exact string that is signed.
+   *
+   * This property is read-only.
+   */
+  readonly baseString: string
+
+  /**
+   * The consumer key.
+   */
+  consumerKey: string
+
+  /**
+   * The consumer secret.
+   */
+  consumerSecret: string
+
+  /**
+   * The URL encoded representation of the Signature property
+   *
+   * This property is read-only.
+   */
+  readonly encodedSignature: string
+
+  /**
+   * The URL that includes the OAuth1 query params.
+   *
+   * This property is read-only.
+   */
+  readonly generatedUrl: string
+
+  /**
+   * The exact HMAC key used to sign the BaseString. An application does not directly set the
+   * HmacKey. The HmacKey property is read-only and is provided for debugging to see the exact HMAC
+   * key used to sign the BaseString. The HMAC key is composed from the consumer secret (if it
+   * exists) and the token secret (if it exists).
+   *
+   * This property is read-only.
+   */
+  readonly hmacKey: string
+
+  /**
+   * The nonce.
+   */
+  nonce: string
+
+  /**
+   * The HTTP method, such as `GET`, `POST`, `PUT`, `DELETE`, or `HEAD`.  Defaults to `GET`.
+   */
+  oauthMethod: string
+
+  /**
+   * The OAuth URL, such as `http://echo.lab.madgex.com/echo.ashx`. See
+   * <http://bettiolo.github.io/oauth-reference-page/> to compare Chilkat results with another
+   * tool's results.
+   *
+   * **Note:** The OAuthUrl should not include query parameters. For example, do not set the
+   * OAuthUrl equal to
+   * ```
+   * https://rest.sandbox.netsuite.com/app/site/hosting/restlet.nl?script=165&deploy=1
+   * ```
+   * Instead, set OAuthUrl equal to
+   * ```
+   * https://rest.sandbox.netsuite.com/app/site/hosting/restlet.nl
+   * ```
+   * and then subsequently call AddParam for each query parameter.
+   */
+  oauthUrl: string
+
+  /**
+   * The oauth_version.  Defaults to `1.0`.  May be set to the empty string to exclude.
+   */
+  oauthVersion: string
+
+  /**
+   * Contains the normalized set of request parameters that are signed. This is a read-only property
+   * made available for debugging purposes.
+   *
+   * This property is read-only.
+   */
+  readonly queryString: string
+
+  /**
+   * The generated base64 signature.
+   *
+   * This property is read-only.
+   */
+  readonly signature: string
+
+  /**
+   * The signature method. Defaults to `HMAC-SHA1`. Other possible choices are `HMAC-SHA256`,
+   * `RSA-SHA1`, and `RSA-SHA256` (or the equivalent `RSA-SHA2`).
+   */
+  signatureMethod: string
+
+  /**
+   * The timestamp, such as `1441632569`.
+   */
+  timestamp: string
+
+  /**
+   * The token.
+   */
+  token: string
+
+  /**
+   * The token secret
+   */
+  tokenSecret: string
+
+  /**
+   * The realm (optional).
+   */
+  realm: string
+
+  /**
+   * This is a catch-all property to be used for uncommon needs. This property defaults to the empty
+   * string and should typically remain empty.
+   *
+   * Can be set to a list of the following comma separated keywords:
+   *
+   * - `INCLUDE_REALM` - Introduced in v9.5.0.85. Include the Realm in the signature calculation and
+   *   outputs.
+   */
+  uncommonOptions: string
+
+  // ---- Methods ----
+
+  /**
+   * Adds an extra name/value parameter to the OAuth1 signature.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link OAuth1.lastErrorText}.
+   */
+  addParam(name: string, value: string): void
+
+  /**
+   * Generates a random nonce `numBytes` in length and sets the Nonce property to the hex encoded
+   * value.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link OAuth1.lastErrorText}.
+   */
+  genNonce(numBytes: number): void
+
+  /**
+   * Sets the Timestamp property to the current date/time.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link OAuth1.lastErrorText}.
+   */
+  genTimestamp(): void
+
+  /**
+   * Generate the signature based on the property settings. Input properties are OauthVersion,
+   * OauthMethod, Url, ConsumerKey, ConsumerSecret, Token, TokenSecret, Nonce, and Timestamp.
+   * Properties set by this method include: BaseString, Signature, HmacKey, EncodedSignature,
+   * QueryString, GeneratedUrl, andAuthorizationHeader.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link OAuth1.lastErrorText}.
+   */
+  generate(): void
+
+  /**
+   * Removes a name/value parameter from the OAuth1 signature.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link OAuth1.lastErrorText}.
+   */
+  removeParam(name: string): void
+
+  /**
+   * Sets the RSA key to be used when the SignatureMethod is set to `RSA-SHA1` or `RSA-SHA2`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link OAuth1.lastErrorText}.
+   */
+  setRsaKey(privKey: PrivateKey): void
+}