Class: Vapi::GcpCredential

Inherits:
Object
  • Object
show all
Defined in:
lib/vapi_server_sdk/types/gcp_credential.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(provider:, id:, org_id:, created_at:, updated_at:, gcp_key:, name: OMIT, bucket_plan: OMIT, additional_properties: nil) ⇒ Vapi::GcpCredential

Parameters:

  • provider (String)
  • id (String) —

    This is the unique identifier for the credential.

  • org_id (String) —

    This is the unique identifier for the org that this credential belongs to.

  • created_at (DateTime) —

    This is the ISO 8601 date-time string of when the credential was created.

  • updated_at (DateTime) —

    This is the ISO 8601 date-time string of when the assistant was last updated.

  • name (String) (defaults to: OMIT) —

    This is the name of the GCP credential. This is just for your reference.

  • gcp_key (Vapi::GcpKey) —

    This is the GCP key. This is the JSON that can be generated in the Google Cloud Console at le.cloud.google.com/iam-admin/serviceaccounts/details/<service-account-id>/keys. The schema is identical to the JSON that GCP outputs.

  • bucket_plan (Vapi::BucketPlan) (defaults to: OMIT) —

    This is the bucket plan that can be provided to store call artifacts in GCP.

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/vapi_server_sdk/types/gcp_credential.rb', line 51

def initialize(provider:, id:, org_id:, created_at:, updated_at:, gcp_key:, name: OMIT, bucket_plan: OMIT,
               additional_properties: nil)
  @provider = provider
  @id = id
  @org_id = org_id
  @created_at = created_at
  @updated_at = updated_at
  @name = name if name != OMIT
  @gcp_key = gcp_key
  @bucket_plan = bucket_plan if bucket_plan != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "provider": provider,
    "id": id,
    "orgId": org_id,
    "createdAt": created_at,
    "updatedAt": updated_at,
    "name": name,
    "gcpKey": gcp_key,
    "bucketPlan": bucket_plan
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



31
32
33
 
# File 'lib/vapi_server_sdk/types/gcp_credential.rb', line 31

def additional_properties
  @additional_properties
end

#bucket_plan ⇒ Vapi::BucketPlan (readonly)

Returns This is the bucket plan that can be provided to store call artifacts in GCP.

Returns:

  • (Vapi::BucketPlan) —

    This is the bucket plan that can be provided to store call artifacts in GCP.



29
30
31
 
# File 'lib/vapi_server_sdk/types/gcp_credential.rb', line 29

def bucket_plan
  @bucket_plan
end

#created_at ⇒ DateTime (readonly)

Returns This is the ISO 8601 date-time string of when the credential was created.

Returns:

  • (DateTime) —

    This is the ISO 8601 date-time string of when the credential was created.



18
19
20
 
# File 'lib/vapi_server_sdk/types/gcp_credential.rb', line 18

def created_at
  @created_at
end

#gcp_key ⇒ Vapi::GcpKey (readonly)

Returns This is the GCP key. This is the JSON that can be generated in the Google Cloud Console at le.cloud.google.com/iam-admin/serviceaccounts/details/<service-account-id>/keys. The schema is identical to the JSON that GCP outputs.

Returns:

  • (Vapi::GcpKey) —

    This is the GCP key. This is the JSON that can be generated in the Google Cloud Console at le.cloud.google.com/iam-admin/serviceaccounts/details/<service-account-id>/keys. The schema is identical to the JSON that GCP outputs.



27
28
29
 
# File 'lib/vapi_server_sdk/types/gcp_credential.rb', line 27

def gcp_key
  @gcp_key
end

#id ⇒ String (readonly)

Returns This is the unique identifier for the credential.

Returns:

  • (String) —

    This is the unique identifier for the credential.



14
15
16
 
# File 'lib/vapi_server_sdk/types/gcp_credential.rb', line 14

def id
  @id
end

#name ⇒ String (readonly)

Returns This is the name of the GCP credential. This is just for your reference.

Returns:

  • (String) —

    This is the name of the GCP credential. This is just for your reference.



22
23
24
 
# File 'lib/vapi_server_sdk/types/gcp_credential.rb', line 22

def name
  @name
end

#org_id ⇒ String (readonly)

Returns This is the unique identifier for the org that this credential belongs to.

Returns:

  • (String) —

    This is the unique identifier for the org that this credential belongs to.



16
17
18
 
# File 'lib/vapi_server_sdk/types/gcp_credential.rb', line 16

def org_id
  @org_id
end

#provider ⇒ String (readonly)

Returns:

  • (String) 


12
13
14
 
# File 'lib/vapi_server_sdk/types/gcp_credential.rb', line 12

def provider
  @provider
end

#updated_at ⇒ DateTime (readonly)

Returns This is the ISO 8601 date-time string of when the assistant was last updated.

Returns:

  • (DateTime) —

    This is the ISO 8601 date-time string of when the assistant was last updated.



20
21
22
 
# File 'lib/vapi_server_sdk/types/gcp_credential.rb', line 20

def updated_at
  @updated_at
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::GcpCredential

Deserialize a JSON object to an instance of GcpCredential

Parameters:

  • json_object (String)

Returns:



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/vapi_server_sdk/types/gcp_credential.rb', line 80

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  provider = parsed_json["provider"]
  id = parsed_json["id"]
  org_id = parsed_json["orgId"]
  created_at = (DateTime.parse(parsed_json["createdAt"]) unless parsed_json["createdAt"].nil?)
  updated_at = (DateTime.parse(parsed_json["updatedAt"]) unless parsed_json["updatedAt"].nil?)
  name = parsed_json["name"]
  if parsed_json["gcpKey"].nil?
    gcp_key = nil
  else
    gcp_key = parsed_json["gcpKey"].to_json
    gcp_key = Vapi::GcpKey.from_json(json_object: gcp_key)
  end
  if parsed_json["bucketPlan"].nil?
    bucket_plan = nil
  else
    bucket_plan = parsed_json["bucketPlan"].to_json
    bucket_plan = Vapi::BucketPlan.from_json(json_object: bucket_plan)
  end
  new(
    provider: provider,
    id: id,
    org_id: org_id,
    created_at: created_at,
    updated_at: updated_at,
    name: name,
    gcp_key: gcp_key,
    bucket_plan: bucket_plan,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


127
128
129
130
131
132
133
134
135
136
 
# File 'lib/vapi_server_sdk/types/gcp_credential.rb', line 127

def self.validate_raw(obj:)
  obj.provider.is_a?(String) != false || raise("Passed value for field obj.provider is not the expected type, validation failed.")
  obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.org_id.is_a?(String) != false || raise("Passed value for field obj.org_id is not the expected type, validation failed.")
  obj.created_at.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
  obj.updated_at.is_a?(DateTime) != false || raise("Passed value for field obj.updated_at is not the expected type, validation failed.")
  obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
  Vapi::GcpKey.validate_raw(obj: obj.gcp_key)
  obj.bucket_plan.nil? || Vapi::BucketPlan.validate_raw(obj: obj.bucket_plan)
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of GcpCredential to a JSON object

Returns:

  • (String) 


117
118
119
 
# File 'lib/vapi_server_sdk/types/gcp_credential.rb', line 117

def to_json(*_args)
  @_field_set&.to_json
end