Class: Vapi::UpdateOrgDto

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(hipaa_enabled: OMIT, subscription_id: OMIT, name: OMIT, channel: OMIT, billing_limit: OMIT, server: OMIT, concurrency_limit: OMIT, compliance_plan: OMIT, additional_properties: nil) ⇒ Vapi::UpdateOrgDto

Parameters:

  • hipaa_enabled (Boolean) (defaults to: OMIT) —

    When this is enabled, no logs, recordings, or transcriptions will be stored. At the end of the call, you will still receive an end-of-call-report message to store on your server. Defaults to false. When HIPAA is enabled, only OpenAI/Custom LLM or Azure Providers will be available for LLM and Voice respectively. This is due to the compliance requirements of HIPAA. Other providers may not meet these requirements.

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

    This is the ID of the subscription the org belongs to.

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

    This is the name of the org. This is just for your own reference.

  • channel (Vapi::UpdateOrgDtoChannel) (defaults to: OMIT) —

    This is the channel of the org. There is the cluster the API traffic for the org will be directed.

  • billing_limit (Float) (defaults to: OMIT) —

    This is the monthly billing limit for the org. To go beyond $1000/mo, please contact us at [email protected].

  • server (Vapi::Server) (defaults to: OMIT) —

    This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema. The order of precedence is:

    1. assistant.server

    2. phoneNumber.server

    3. org.server

  • concurrency_limit (Float) (defaults to: OMIT) —

    This is the concurrency limit for the org. This is the maximum number of calls that can be active at any given time. To go beyond 10, please contact us at [email protected].

  • compliance_plan (Vapi::CompliancePlan) (defaults to: OMIT) —

    Stores the information about the compliance plan enforced at the organization level. Currently pciEnabled is supported through this field. When this is enabled, any logs, recordings, or transcriptions will be shipped to the customer endpoints if provided else lost. At the end of the call, you will receive an end-of-call-report message to store on your server, if webhook is provided. Defaults to false. When PCI is enabled, only PCI-compliant Providers will be available for LLM, Voice and transcribers. This is due to the compliance requirements of PCI. Other providers may not meet these requirements.

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

    Additional properties unmapped to the current class definition



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/vapi_server_sdk/types/update_org_dto.rb', line 95

def initialize(hipaa_enabled: OMIT, subscription_id: OMIT, name: OMIT, channel: OMIT, billing_limit: OMIT,
               server: OMIT, concurrency_limit: OMIT, compliance_plan: OMIT, additional_properties: nil)
  @hipaa_enabled = hipaa_enabled if hipaa_enabled != OMIT
  @subscription_id = subscription_id if subscription_id != OMIT
  @name = name if name != OMIT
  @channel = channel if channel != OMIT
  @billing_limit = billing_limit if billing_limit != OMIT
  @server = server if server != OMIT
  @concurrency_limit = concurrency_limit if concurrency_limit != OMIT
  @compliance_plan = compliance_plan if compliance_plan != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "hipaaEnabled": hipaa_enabled,
    "subscriptionId": subscription_id,
    "name": name,
    "channel": channel,
    "billingLimit": billing_limit,
    "server": server,
    "concurrencyLimit": concurrency_limit,
    "compliancePlan": compliance_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



53
54
55
 
# File 'lib/vapi_server_sdk/types/update_org_dto.rb', line 53

def additional_properties
  @additional_properties
end

#billing_limit ⇒ Float (readonly)

Returns This is the monthly billing limit for the org. To go beyond $1000/mo, please contact us at [email protected].

Returns:

  • (Float) —

    This is the monthly billing limit for the org. To go beyond $1000/mo, please contact us at [email protected].



28
29
30
 
# File 'lib/vapi_server_sdk/types/update_org_dto.rb', line 28

def billing_limit
  @billing_limit
end

#channel ⇒ Vapi::UpdateOrgDtoChannel (readonly)

Returns This is the channel of the org. There is the cluster the API traffic for the org will be directed.

Returns:

  • (Vapi::UpdateOrgDtoChannel) —

    This is the channel of the org. There is the cluster the API traffic for the org will be directed.



25
26
27
 
# File 'lib/vapi_server_sdk/types/update_org_dto.rb', line 25

def channel
  @channel
end

#compliance_plan ⇒ Vapi::CompliancePlan (readonly)

Returns Stores the information about the compliance plan enforced at the organization level. Currently pciEnabled is supported through this field. When this is enabled, any logs, recordings, or transcriptions will be shipped to the customer endpoints if provided else lost. At the end of the call, you will receive an end-of-call-report message to store on your server, if webhook is provided. Defaults to false. When PCI is enabled, only PCI-compliant Providers will be available for LLM, Voice and transcribers. This is due to the compliance requirements of PCI. Other providers may not meet these requirements.

Returns:

  • (Vapi::CompliancePlan) —

    Stores the information about the compliance plan enforced at the organization level. Currently pciEnabled is supported through this field. When this is enabled, any logs, recordings, or transcriptions will be shipped to the customer endpoints if provided else lost. At the end of the call, you will receive an end-of-call-report message to store on your server, if webhook is provided. Defaults to false. When PCI is enabled, only PCI-compliant Providers will be available for LLM, Voice and transcribers. This is due to the compliance requirements of PCI. Other providers may not meet these requirements.



51
52
53
 
# File 'lib/vapi_server_sdk/types/update_org_dto.rb', line 51

def compliance_plan
  @compliance_plan
end

#concurrency_limit ⇒ Float (readonly)

Returns This is the concurrency limit for the org. This is the maximum number of calls that can be active at any given time. To go beyond 10, please contact us at [email protected].

Returns:

  • (Float) —

    This is the concurrency limit for the org. This is the maximum number of calls that can be active at any given time. To go beyond 10, please contact us at [email protected].



39
40
41
 
# File 'lib/vapi_server_sdk/types/update_org_dto.rb', line 39

def concurrency_limit
  @concurrency_limit
end

#hipaa_enabled ⇒ Boolean (readonly)

Returns When this is enabled, no logs, recordings, or transcriptions will be stored. At the end of the call, you will still receive an end-of-call-report message to store on your server. Defaults to false. When HIPAA is enabled, only OpenAI/Custom LLM or Azure Providers will be available for LLM and Voice respectively. This is due to the compliance requirements of HIPAA. Other providers may not meet these requirements.

Returns:

  • (Boolean) —

    When this is enabled, no logs, recordings, or transcriptions will be stored. At the end of the call, you will still receive an end-of-call-report message to store on your server. Defaults to false. When HIPAA is enabled, only OpenAI/Custom LLM or Azure Providers will be available for LLM and Voice respectively. This is due to the compliance requirements of HIPAA. Other providers may not meet these requirements.



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

def hipaa_enabled
  @hipaa_enabled
end

#name ⇒ String (readonly)

Returns This is the name of the org. This is just for your own reference.

Returns:

  • (String) —

    This is the name of the org. This is just for your own reference.



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

def name
  @name
end

#server ⇒ Vapi::Server (readonly)

Returns This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema. The order of precedence is:

  1. assistant.server

  2. phoneNumber.server

  3. org.server.

Returns:

  • (Vapi::Server) —

    This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema. The order of precedence is:

    1. assistant.server

    2. phoneNumber.server

    3. org.server



35
36
37
 
# File 'lib/vapi_server_sdk/types/update_org_dto.rb', line 35

def server
  @server
end

#subscription_id ⇒ String (readonly)

Returns This is the ID of the subscription the org belongs to.

Returns:

  • (String) —

    This is the ID of the subscription the org belongs to.



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

def subscription_id
  @subscription_id
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::UpdateOrgDto

Deserialize a JSON object to an instance of UpdateOrgDto

Parameters:

  • json_object (String)

Returns:



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/vapi_server_sdk/types/update_org_dto.rb', line 124

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  hipaa_enabled = parsed_json["hipaaEnabled"]
  subscription_id = parsed_json["subscriptionId"]
  name = parsed_json["name"]
  channel = parsed_json["channel"]
  billing_limit = parsed_json["billingLimit"]
  if parsed_json["server"].nil?
    server = nil
  else
    server = parsed_json["server"].to_json
    server = Vapi::Server.from_json(json_object: server)
  end
  concurrency_limit = parsed_json["concurrencyLimit"]
  if parsed_json["compliancePlan"].nil?
    compliance_plan = nil
  else
    compliance_plan = parsed_json["compliancePlan"].to_json
    compliance_plan = Vapi::CompliancePlan.from_json(json_object: compliance_plan)
  end
  new(
    hipaa_enabled: hipaa_enabled,
    subscription_id: subscription_id,
    name: name,
    channel: channel,
    billing_limit: billing_limit,
    server: server,
    concurrency_limit: concurrency_limit,
    compliance_plan: compliance_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) 


171
172
173
174
175
176
177
178
179
180
 
# File 'lib/vapi_server_sdk/types/update_org_dto.rb', line 171

def self.validate_raw(obj:)
  obj.hipaa_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.hipaa_enabled is not the expected type, validation failed.")
  obj.subscription_id&.is_a?(String) != false || raise("Passed value for field obj.subscription_id 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.")
  obj.channel&.is_a?(Vapi::UpdateOrgDtoChannel) != false || raise("Passed value for field obj.channel is not the expected type, validation failed.")
  obj.billing_limit&.is_a?(Float) != false || raise("Passed value for field obj.billing_limit is not the expected type, validation failed.")
  obj.server.nil? || Vapi::Server.validate_raw(obj: obj.server)
  obj.concurrency_limit&.is_a?(Float) != false || raise("Passed value for field obj.concurrency_limit is not the expected type, validation failed.")
  obj.compliance_plan.nil? || Vapi::CompliancePlan.validate_raw(obj: obj.compliance_plan)
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of UpdateOrgDto to a JSON object

Returns:

  • (String) 


161
162
163
 
# File 'lib/vapi_server_sdk/types/update_org_dto.rb', line 161

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