@algolia/ingestion 1.0.0-alpha.82 → 1.0.0-alpha.84

package/model/authBasicPartial.ts

@@ -1,10 +1,16 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Authentication input for Basic login with username and password.
+ * Credentials for authenticating with user name and password.
  */
 export type AuthBasicPartial = {
+  /**
+   * Username.
+   */
   username?: string;
 
+  /**
+   * Password. This field is `null` in the API response.
+   */
   password?: string;
 };

package/model/authGoogleServiceAccount.ts

@@ -1,16 +1,16 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Authentication input to connect to a Google service (e.g. BigQuery).
+ * Credentials for authenticating with a Google service account, such as BigQuery.
  */
 export type AuthGoogleServiceAccount = {
   /**
-   * Email address of the Service Account.
+   * Email address of the Google service account.
    */
   clientEmail: string;
 
   /**
-   * Private key of the Service Account.
+   * Private key of the Google service account. This field is `null` in the API response.
    */
   privateKey: string;
 };

package/model/authGoogleServiceAccountPartial.ts

@@ -1,16 +1,16 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Authentication input to connect to a Google service (e.g. BigQuery).
+ * Credentials for authenticating with a Google service account, such as BigQuery.
  */
 export type AuthGoogleServiceAccountPartial = {
   /**
-   * Email address of the Service Account.
+   * Email address of the Google service account.
    */
   clientEmail?: string;
 
   /**
-   * Private key of the Service Account.
+   * Private key of the Google service account. This field is `null` in the API response.
    */
   privateKey?: string;
 };

package/model/authOAuth.ts

@@ -1,21 +1,26 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Authentication input for OAuth login.
+ * Credentials for authenticating with OAuth 2.0.
  */
 export type AuthOAuth = {
   /**
-   * The OAuth endpoint URL.
+   * URL for the OAuth endpoint.
    */
   url: string;
 
   /**
-   * The clientID.
+   * Client ID.
    */
   client_id: string;
 
   /**
-   * The secret.
+   * Client secret. This field is `null` in the API response.
    */
   client_secret: string;
+
+  /**
+   * OAuth scope.
+   */
+  scope?: string;
 };

package/model/authOAuthPartial.ts

@@ -1,21 +1,26 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Authentication input for OAuth login.
+ * Credentials for authenticating with OAuth 2.0.
  */
 export type AuthOAuthPartial = {
   /**
-   * The OAuth endpoint URL.
+   * URL for the OAuth endpoint.
    */
   url?: string;
 
   /**
-   * The clientID.
+   * Client ID.
    */
   client_id?: string;
 
   /**
-   * The secret.
+   * Client secret. This field is `null` in the API response.
    */
   client_secret?: string;
+
+  /**
+   * OAuth scope.
+   */
+  scope?: string;
 };

package/model/authentication.ts

@@ -5,18 +5,18 @@ import type { AuthenticationType } from './authenticationType';
 import type { Platform } from './platform';
 
 /**
- * An authentication is used to login into a Source or a Destination, with obfuscated input.
+ * Resource representing the information required to authenticate with a source or a destination.
  */
 export type Authentication = {
   /**
-   * The authentication UUID.
+   * Universally unique identifier (UUID) of an authentication resource.
    */
   authenticationID: string;
 
   type: AuthenticationType;
 
   /**
-   * An human readable name describing the object.
+   * Descriptive name for the resource.
    */
   name: string;
 
@@ -25,12 +25,12 @@ export type Authentication = {
   input: AuthInputPartial;
 
   /**
-   * Date of creation (RFC3339 format).
+   * Date of creation in RFC3339 format.
    */
   createdAt: string;
 
   /**
-   * Date of last update (RFC3339 format).
+   * Date of last update in RFC3339 format.
    */
   updatedAt?: string;
 };

package/model/authenticationCreate.ts

@@ -5,13 +5,13 @@ import type { AuthenticationType } from './authenticationType';
 import type { Platform } from './platform';
 
 /**
- * The payload when creating an authentication.
+ * Request body for creating a new authentication resource.
  */
 export type AuthenticationCreate = {
   type: AuthenticationType;
 
   /**
-   * An human readable name describing the object.
+   * Descriptive name for the resource.
    */
   name: string;
 

package/model/authenticationCreateResponse.ts

@@ -1,21 +1,21 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Response from the API when the Authentication is successfully created.
+ * API response for the successful creation of an authentication resource.
  */
 export type AuthenticationCreateResponse = {
   /**
-   * The authentication UUID.
+   * Universally unique identifier (UUID) of an authentication resource.
    */
   authenticationID: string;
 
   /**
-   * An human readable name describing the object.
+   * Descriptive name for the resource.
    */
   name: string;
 
   /**
-   * Date of creation (RFC3339 format).
+   * Date of creation in RFC3339 format.
    */
   createdAt: string;
 };

package/model/authenticationSearch.ts

@@ -1,7 +1,7 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Payload to search for multiple authentications, based on the given `authenticationIDs`.
+ * Request body for searching for authentication resources.
  */
 export type AuthenticationSearch = {
   authenticationIDs: string[];

package/model/authenticationSortKeys.ts

@@ -1,7 +1,7 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Used to sort the Authentication list endpoint.
+ * Property by which to sort the list of authentication resources.
  */
 export type AuthenticationSortKeys =
   | 'auth_type'

package/model/authenticationType.ts

@@ -1,7 +1,7 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Type of the Authentication, defines what kind of object is stored in the input.
+ * Type of authentication. This determines the type of credentials required in the `input` object.
  */
 export type AuthenticationType =
   | 'algolia'

package/model/authenticationUpdate.ts

@@ -5,13 +5,13 @@ import type { AuthenticationType } from './authenticationType';
 import type { Platform } from './platform';
 
 /**
- * Payload to partially update an Authentication.
+ * Request body for updating an authentication resource.
  */
 export type AuthenticationUpdate = {
   type?: AuthenticationType;
 
   /**
-   * An human readable name describing the object.
+   * Descriptive name for the resource.
    */
   name?: string;
 

package/model/authenticationUpdateResponse.ts

@@ -1,21 +1,21 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Response from the API when the Authentication is successfully updated.
+ * API response for a successful update of an authentication resource.
  */
 export type AuthenticationUpdateResponse = {
   /**
-   * The authentication UUID.
+   * Universally unique identifier (UUID) of an authentication resource.
    */
   authenticationID: string;
 
   /**
-   * An human readable name describing the object.
+   * Descriptive name for the resource.
    */
   name: string;
 
   /**
-   * Date of last update (RFC3339 format).
+   * Date of last update in RFC3339 format.
    */
   updatedAt: string;
 };

package/model/bigCommerceChannel.ts

@@ -2,12 +2,12 @@
 
 export type BigCommerceChannel = {
   /**
-   * The ID of the bigcommerce channel.
+   * ID of the BigCommerce channel.
    */
   id: number;
 
   /**
-   * An array of currencies for the given channel `ID`, a currency is a trigram string that represents the currency code.
+   * Currencies for the given channel.
    */
   currencies?: string[];
 };

package/model/bigCommerceMetafield.ts

@@ -2,12 +2,12 @@
 
 export type BigCommerceMetafield = {
   /**
-   * The namespace of the metafield.
+   * Namespace of the metafield.
    */
   namespace: string;
 
   /**
-   * The key identifier of the metafield.
+   * Key identifier of the metafield.
    */
   key: string;
 };