@formalingo/sdk 0.1.3 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (166) hide show
  1. package/README.md +31 -9
  2. package/dist/client/api/v1/analytics/index.d.ts +20 -0
  3. package/dist/client/api/v1/analytics/index.d.ts.map +1 -0
  4. package/dist/client/api/v1/analytics/index.js +20 -0
  5. package/dist/client/api/v1/analytics/index.js.map +1 -0
  6. package/dist/client/api/v1/analytics/summary/index.d.ts +131 -0
  7. package/dist/client/api/v1/analytics/summary/index.d.ts.map +1 -0
  8. package/dist/client/api/v1/analytics/summary/index.js +137 -0
  9. package/dist/client/api/v1/analytics/summary/index.js.map +1 -0
  10. package/dist/client/api/v1/deliveries/index.d.ts +192 -0
  11. package/dist/client/api/v1/deliveries/index.d.ts.map +1 -0
  12. package/dist/client/api/v1/deliveries/index.js +189 -0
  13. package/dist/client/api/v1/deliveries/index.js.map +1 -0
  14. package/dist/client/api/v1/documents/importEscaped/index.d.ts +144 -0
  15. package/dist/client/api/v1/documents/importEscaped/index.d.ts.map +1 -0
  16. package/dist/client/api/v1/documents/importEscaped/index.js +153 -0
  17. package/dist/client/api/v1/documents/importEscaped/index.js.map +1 -0
  18. package/dist/client/api/v1/documents/index.d.ts +5 -0
  19. package/dist/client/api/v1/documents/index.d.ts.map +1 -1
  20. package/dist/client/api/v1/documents/index.js +5 -0
  21. package/dist/client/api/v1/documents/index.js.map +1 -1
  22. package/dist/client/api/v1/documents/item/exportEscaped/index.d.ts +103 -0
  23. package/dist/client/api/v1/documents/item/exportEscaped/index.d.ts.map +1 -0
  24. package/dist/client/api/v1/documents/item/exportEscaped/index.js +102 -0
  25. package/dist/client/api/v1/documents/item/exportEscaped/index.js.map +1 -0
  26. package/dist/client/api/v1/documents/item/fields/index.d.ts +121 -7
  27. package/dist/client/api/v1/documents/item/fields/index.d.ts.map +1 -1
  28. package/dist/client/api/v1/documents/item/fields/index.js +125 -0
  29. package/dist/client/api/v1/documents/item/fields/index.js.map +1 -1
  30. package/dist/client/api/v1/documents/item/fields/item/index.d.ts +106 -16
  31. package/dist/client/api/v1/documents/item/fields/item/index.d.ts.map +1 -1
  32. package/dist/client/api/v1/documents/item/fields/item/index.js +97 -4
  33. package/dist/client/api/v1/documents/item/fields/item/index.js.map +1 -1
  34. package/dist/client/api/v1/documents/item/index.d.ts +104 -6
  35. package/dist/client/api/v1/documents/item/index.d.ts.map +1 -1
  36. package/dist/client/api/v1/documents/item/index.js +111 -4
  37. package/dist/client/api/v1/documents/item/index.js.map +1 -1
  38. package/dist/client/api/v1/documents/item/parseJobs/index.d.ts +155 -0
  39. package/dist/client/api/v1/documents/item/parseJobs/index.d.ts.map +1 -0
  40. package/dist/client/api/v1/documents/item/parseJobs/index.js +163 -0
  41. package/dist/client/api/v1/documents/item/parseJobs/index.js.map +1 -0
  42. package/dist/client/api/v1/documents/item/parseJobs/item/apply/index.d.ts +180 -0
  43. package/dist/client/api/v1/documents/item/parseJobs/item/apply/index.d.ts.map +1 -0
  44. package/dist/client/api/v1/documents/item/parseJobs/item/apply/index.js +189 -0
  45. package/dist/client/api/v1/documents/item/parseJobs/item/apply/index.js.map +1 -0
  46. package/dist/client/api/v1/documents/item/parseJobs/item/index.d.ts +75 -0
  47. package/dist/client/api/v1/documents/item/parseJobs/item/index.d.ts.map +1 -0
  48. package/dist/client/api/v1/documents/item/parseJobs/item/index.js +76 -0
  49. package/dist/client/api/v1/documents/item/parseJobs/item/index.js.map +1 -0
  50. package/dist/client/api/v1/documents/item/publish/index.d.ts +200 -0
  51. package/dist/client/api/v1/documents/item/publish/index.d.ts.map +1 -0
  52. package/dist/client/api/v1/documents/item/publish/index.js +220 -0
  53. package/dist/client/api/v1/documents/item/publish/index.js.map +1 -0
  54. package/dist/client/api/v1/documents/item/revisions/index.d.ts +112 -0
  55. package/dist/client/api/v1/documents/item/revisions/index.d.ts.map +1 -0
  56. package/dist/client/api/v1/documents/item/revisions/index.js +110 -0
  57. package/dist/client/api/v1/documents/item/revisions/index.js.map +1 -0
  58. package/dist/client/api/v1/documents/item/revisions/item/index.d.ts +95 -0
  59. package/dist/client/api/v1/documents/item/revisions/item/index.d.ts.map +1 -0
  60. package/dist/client/api/v1/documents/item/revisions/item/index.js +102 -0
  61. package/dist/client/api/v1/documents/item/revisions/item/index.js.map +1 -0
  62. package/dist/client/api/v1/documents/item/signerRoles/index.d.ts +1 -0
  63. package/dist/client/api/v1/documents/item/signerRoles/index.d.ts.map +1 -1
  64. package/dist/client/api/v1/documents/item/signerRoles/index.js +4 -1
  65. package/dist/client/api/v1/documents/item/signerRoles/index.js.map +1 -1
  66. package/dist/client/api/v1/documents/item/signerRoles/item/index.d.ts +121 -1
  67. package/dist/client/api/v1/documents/item/signerRoles/item/index.d.ts.map +1 -1
  68. package/dist/client/api/v1/documents/item/signerRoles/item/index.js +133 -0
  69. package/dist/client/api/v1/documents/item/signerRoles/item/index.js.map +1 -1
  70. package/dist/client/api/v1/documents/item/submissions/index.d.ts +40 -30
  71. package/dist/client/api/v1/documents/item/submissions/index.d.ts.map +1 -1
  72. package/dist/client/api/v1/documents/item/submissions/index.js +36 -28
  73. package/dist/client/api/v1/documents/item/submissions/index.js.map +1 -1
  74. package/dist/client/api/v1/documents/item/submissions/item/expire/index.d.ts +280 -0
  75. package/dist/client/api/v1/documents/item/submissions/item/expire/index.d.ts.map +1 -0
  76. package/dist/client/api/v1/documents/item/submissions/item/expire/index.js +301 -0
  77. package/dist/client/api/v1/documents/item/submissions/item/expire/index.js.map +1 -0
  78. package/dist/client/api/v1/documents/item/submissions/item/index.d.ts +86 -1
  79. package/dist/client/api/v1/documents/item/submissions/item/index.d.ts.map +1 -1
  80. package/dist/client/api/v1/documents/item/submissions/item/index.js +92 -0
  81. package/dist/client/api/v1/documents/item/submissions/item/index.js.map +1 -1
  82. package/dist/client/api/v1/documents/item/submissions/item/pdf/index.d.ts +42 -0
  83. package/dist/client/api/v1/documents/item/submissions/item/pdf/index.d.ts.map +1 -1
  84. package/dist/client/api/v1/documents/item/submissions/item/pdf/index.js +43 -0
  85. package/dist/client/api/v1/documents/item/submissions/item/pdf/index.js.map +1 -1
  86. package/dist/client/api/v1/documents/item/submissions/item/signers/item/index.d.ts +5 -41
  87. package/dist/client/api/v1/documents/item/submissions/item/signers/item/index.d.ts.map +1 -1
  88. package/dist/client/api/v1/documents/item/submissions/item/signers/item/index.js +7 -44
  89. package/dist/client/api/v1/documents/item/submissions/item/signers/item/index.js.map +1 -1
  90. package/dist/client/api/v1/documents/item/submissions/item/signers/item/responses/index.d.ts +7 -2
  91. package/dist/client/api/v1/documents/item/submissions/item/signers/item/responses/index.d.ts.map +1 -1
  92. package/dist/client/api/v1/documents/item/submissions/item/signers/item/responses/index.js +5 -0
  93. package/dist/client/api/v1/documents/item/submissions/item/signers/item/responses/index.js.map +1 -1
  94. package/dist/client/api/v1/files/index.d.ts +22 -0
  95. package/dist/client/api/v1/files/index.d.ts.map +1 -0
  96. package/dist/client/api/v1/files/index.js +21 -0
  97. package/dist/client/api/v1/files/index.js.map +1 -0
  98. package/dist/client/api/v1/files/item/download/index.d.ts +180 -0
  99. package/dist/client/api/v1/files/item/download/index.d.ts.map +1 -0
  100. package/dist/client/api/v1/files/item/download/index.js +189 -0
  101. package/dist/client/api/v1/files/item/download/index.js.map +1 -0
  102. package/dist/client/api/v1/files/item/index.d.ts +20 -0
  103. package/dist/client/api/v1/files/item/index.d.ts.map +1 -0
  104. package/dist/client/api/v1/files/item/index.js +20 -0
  105. package/dist/client/api/v1/files/item/index.js.map +1 -0
  106. package/dist/client/api/v1/forms/index.d.ts +46 -1
  107. package/dist/client/api/v1/forms/index.d.ts.map +1 -1
  108. package/dist/client/api/v1/forms/index.js +22 -1
  109. package/dist/client/api/v1/forms/index.js.map +1 -1
  110. package/dist/client/api/v1/forms/item/index.d.ts +18 -0
  111. package/dist/client/api/v1/forms/item/index.d.ts.map +1 -1
  112. package/dist/client/api/v1/forms/item/index.js +15 -0
  113. package/dist/client/api/v1/forms/item/index.js.map +1 -1
  114. package/dist/client/api/v1/forms/item/publish/index.d.ts +200 -0
  115. package/dist/client/api/v1/forms/item/publish/index.d.ts.map +1 -0
  116. package/dist/client/api/v1/forms/item/publish/index.js +220 -0
  117. package/dist/client/api/v1/forms/item/publish/index.js.map +1 -0
  118. package/dist/client/api/v1/forms/item/recipients/bulk/index.d.ts +274 -0
  119. package/dist/client/api/v1/forms/item/recipients/bulk/index.d.ts.map +1 -0
  120. package/dist/client/api/v1/forms/item/recipients/bulk/index.js +302 -0
  121. package/dist/client/api/v1/forms/item/recipients/bulk/index.js.map +1 -0
  122. package/dist/client/api/v1/forms/item/recipients/index.d.ts +10 -4
  123. package/dist/client/api/v1/forms/item/recipients/index.d.ts.map +1 -1
  124. package/dist/client/api/v1/forms/item/recipients/index.js +11 -3
  125. package/dist/client/api/v1/forms/item/recipients/index.js.map +1 -1
  126. package/dist/client/api/v1/forms/item/recipients/item/index.d.ts +3 -2
  127. package/dist/client/api/v1/forms/item/recipients/item/index.d.ts.map +1 -1
  128. package/dist/client/api/v1/forms/item/recipients/item/index.js +6 -3
  129. package/dist/client/api/v1/forms/item/recipients/item/index.js.map +1 -1
  130. package/dist/client/api/v1/forms/item/recipients/item/responses/index.d.ts +4 -0
  131. package/dist/client/api/v1/forms/item/recipients/item/responses/index.d.ts.map +1 -1
  132. package/dist/client/api/v1/forms/item/recipients/item/responses/index.js +2 -0
  133. package/dist/client/api/v1/forms/item/recipients/item/responses/index.js.map +1 -1
  134. package/dist/client/api/v1/forms/item/revisions/index.d.ts +112 -0
  135. package/dist/client/api/v1/forms/item/revisions/index.d.ts.map +1 -0
  136. package/dist/client/api/v1/forms/item/revisions/index.js +110 -0
  137. package/dist/client/api/v1/forms/item/revisions/index.js.map +1 -0
  138. package/dist/client/api/v1/forms/item/revisions/item/index.d.ts +95 -0
  139. package/dist/client/api/v1/forms/item/revisions/item/index.d.ts.map +1 -0
  140. package/dist/client/api/v1/forms/item/revisions/item/index.js +102 -0
  141. package/dist/client/api/v1/forms/item/revisions/item/index.js.map +1 -0
  142. package/dist/client/api/v1/index.d.ts +25 -0
  143. package/dist/client/api/v1/index.d.ts.map +1 -1
  144. package/dist/client/api/v1/index.js +25 -0
  145. package/dist/client/api/v1/index.js.map +1 -1
  146. package/dist/client/api/v1/integrations/index.d.ts +20 -0
  147. package/dist/client/api/v1/integrations/index.d.ts.map +1 -0
  148. package/dist/client/api/v1/integrations/index.js +20 -0
  149. package/dist/client/api/v1/integrations/index.js.map +1 -0
  150. package/dist/client/api/v1/integrations/status/index.d.ts +168 -0
  151. package/dist/client/api/v1/integrations/status/index.d.ts.map +1 -0
  152. package/dist/client/api/v1/integrations/status/index.js +177 -0
  153. package/dist/client/api/v1/integrations/status/index.js.map +1 -0
  154. package/dist/client/api/v1/quota/index.d.ts +93 -0
  155. package/dist/client/api/v1/quota/index.d.ts.map +1 -0
  156. package/dist/client/api/v1/quota/index.js +99 -0
  157. package/dist/client/api/v1/quota/index.js.map +1 -0
  158. package/dist/client/models/index.d.ts +1961 -137
  159. package/dist/client/models/index.d.ts.map +1 -1
  160. package/dist/client/models/index.js +2001 -211
  161. package/dist/client/models/index.js.map +1 -1
  162. package/dist/index.d.ts +15 -0
  163. package/dist/index.d.ts.map +1 -1
  164. package/dist/index.js +89 -1
  165. package/dist/index.js.map +1 -1
  166. package/package.json +1 -1
package/README.md CHANGED
@@ -15,7 +15,11 @@ pnpm add @formalingo/sdk
15
15
  ## Quick Start
16
16
 
17
17
  ```typescript
18
- import { createClient } from "@formalingo/sdk"
18
+ import {
19
+ createBulkRecipients,
20
+ createClient,
21
+ createDocumentSubmission,
22
+ } from "@formalingo/sdk"
19
23
 
20
24
  const client = createClient("af_live_YOUR_API_KEY")
21
25
 
@@ -120,8 +124,24 @@ const recipient = await client.forms.byFormId("form-id").recipients.post({
120
124
 
121
125
  // The shareable form URL
122
126
  const formUrl = `https://www.formalingo.com/f/${recipient.token}`
127
+
128
+ // Create up to 100 recipients. Reuse this key only for an exact retry.
129
+ const recipients = await createBulkRecipients(
130
+ client,
131
+ "00000000-0000-0000-0000-000000000001",
132
+ {
133
+ confirmBulk: true,
134
+ recipients: [
135
+ { label: "Alice", email: "alice@example.com" },
136
+ { label: "Bob", phone: "+1 202-555-0100" },
137
+ ],
138
+ },
139
+ "recipient-bulk-create-7f3f",
140
+ )
123
141
  ```
124
142
 
143
+ On `idempotency_request_in_progress`, retry the exact body with the same key. A different body returns `idempotency_key_conflict`; recipient erasure returns `idempotency_replay_unavailable`.
144
+
125
145
  ### Branding
126
146
 
127
147
  ```typescript
@@ -143,17 +163,19 @@ await client.forms.byFormId("form-id").branding.put({
143
163
  // List documents
144
164
  const documents = await client.documents.get()
145
165
 
146
- // Create a document with signers
147
- const doc = await client.documents.post({
148
- body: {
149
- title: "NDA Agreement",
150
- content: "Full document text...",
166
+ // Create a signing submission with a caller-owned idempotency key
167
+ const submission = await createDocumentSubmission(
168
+ client,
169
+ "00000000-0000-0000-0000-000000000001",
170
+ {
151
171
  signers: [
152
- { name: "Alice", email: "alice@example.com" },
153
- { name: "Bob", email: "bob@example.com" },
172
+ { role: "signer_1", name: "Alice", email: "alice@example.com" },
154
173
  ],
155
174
  },
156
- })
175
+ "document-create-7f3f",
176
+ )
177
+
178
+ console.log(submission.signers?.[0]?.link)
157
179
  ```
158
180
 
159
181
  ### Error Handling
@@ -0,0 +1,20 @@
1
+ import { type SummaryRequestBuilder } from './summary/index.js';
2
+ import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata } from '@microsoft/kiota-abstractions';
3
+ /**
4
+ * Builds and executes requests for operations under /api/v1/analytics
5
+ */
6
+ export interface AnalyticsRequestBuilder extends BaseRequestBuilder<AnalyticsRequestBuilder> {
7
+ /**
8
+ * The summary property
9
+ */
10
+ get summary(): SummaryRequestBuilder;
11
+ }
12
+ /**
13
+ * Uri template for the request builder.
14
+ */
15
+ export declare const AnalyticsRequestBuilderUriTemplate = "{+baseurl}/api/v1/analytics";
16
+ /**
17
+ * Metadata for all the navigation properties in the request builder.
18
+ */
19
+ export declare const AnalyticsRequestBuilderNavigationMetadata: Record<Exclude<keyof AnalyticsRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
20
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/client/api/v1/analytics/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAyC,KAAK,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAEvG,OAAO,EAAE,KAAK,kBAAkB,EAAE,KAAK,kCAAkC,EAAE,KAAK,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAE1I;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,kBAAkB,CAAC,uBAAuB,CAAC;IACxF;;OAEG;IACH,IAAI,OAAO,IAAI,qBAAqB,CAAC;CACxC;AACD;;GAEG;AACH,eAAO,MAAM,kCAAkC,gCAAgC,CAAC;AAChF;;GAEG;AACH,eAAO,MAAM,yCAAyC,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,uBAAuB,EAAE,kCAAkC,CAAC,EAAE,kBAAkB,CAI5J,CAAC"}
@@ -0,0 +1,20 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ // Generated by Microsoft Kiota
4
+ // @ts-ignore
5
+ import { SummaryRequestBuilderRequestsMetadata } from './summary/index.js';
6
+ /**
7
+ * Uri template for the request builder.
8
+ */
9
+ export const AnalyticsRequestBuilderUriTemplate = "{+baseurl}/api/v1/analytics";
10
+ /**
11
+ * Metadata for all the navigation properties in the request builder.
12
+ */
13
+ export const AnalyticsRequestBuilderNavigationMetadata = {
14
+ summary: {
15
+ requestsMetadata: SummaryRequestBuilderRequestsMetadata,
16
+ },
17
+ };
18
+ /* tslint:enable */
19
+ /* eslint-enable */
20
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/client/api/v1/analytics/index.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB,+BAA+B;AAC/B,aAAa;AACb,OAAO,EAAE,qCAAqC,EAA8B,MAAM,oBAAoB,CAAC;AAavG;;GAEG;AACH,MAAM,CAAC,MAAM,kCAAkC,GAAG,6BAA6B,CAAC;AAChF;;GAEG;AACH,MAAM,CAAC,MAAM,yCAAyC,GAA2G;IAC7J,OAAO,EAAE;QACL,gBAAgB,EAAE,qCAAqC;KAC1D;CACJ,CAAC;AACF,mBAAmB;AACnB,mBAAmB"}
@@ -0,0 +1,131 @@
1
+ import { type AdditionalDataHolder, type ApiError, type BaseRequestBuilder, type Parsable, type ParseNode, type RequestConfiguration, type RequestInformation, type RequestsMetadata, type SerializationWriter } from '@microsoft/kiota-abstractions';
2
+ /**
3
+ * Creates a new instance of the appropriate class based on discriminator value
4
+ * @param parseNode The parse node to use to read the discriminator value and create the object
5
+ * @returns {Summary403Error}
6
+ */
7
+ export declare function createSummary403ErrorFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
8
+ /**
9
+ * Creates a new instance of the appropriate class based on discriminator value
10
+ * @param parseNode The parse node to use to read the discriminator value and create the object
11
+ * @returns {SummaryGetResponse_data}
12
+ */
13
+ export declare function createSummaryGetResponse_dataFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
14
+ /**
15
+ * Creates a new instance of the appropriate class based on discriminator value
16
+ * @param parseNode The parse node to use to read the discriminator value and create the object
17
+ * @returns {SummaryGetResponse}
18
+ */
19
+ export declare function createSummaryGetResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
20
+ /**
21
+ * The deserialization information for the current model
22
+ * @param Summary403Error The instance to deserialize into.
23
+ * @returns {Record<string, (node: ParseNode) => void>}
24
+ */
25
+ export declare function deserializeIntoSummary403Error(summary403Error?: Partial<Summary403Error> | undefined): Record<string, (node: ParseNode) => void>;
26
+ /**
27
+ * The deserialization information for the current model
28
+ * @param SummaryGetResponse The instance to deserialize into.
29
+ * @returns {Record<string, (node: ParseNode) => void>}
30
+ */
31
+ export declare function deserializeIntoSummaryGetResponse(summaryGetResponse?: Partial<SummaryGetResponse> | undefined): Record<string, (node: ParseNode) => void>;
32
+ /**
33
+ * The deserialization information for the current model
34
+ * @param SummaryGetResponse_data The instance to deserialize into.
35
+ * @returns {Record<string, (node: ParseNode) => void>}
36
+ */
37
+ export declare function deserializeIntoSummaryGetResponse_data(summaryGetResponse_data?: Partial<SummaryGetResponse_data> | undefined): Record<string, (node: ParseNode) => void>;
38
+ /**
39
+ * Serializes information the current object
40
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
41
+ * @param Summary403Error The instance to serialize from.
42
+ * @param writer Serialization writer to use to serialize this model
43
+ */
44
+ export declare function serializeSummary403Error(writer: SerializationWriter, summary403Error?: Partial<Summary403Error> | undefined | null, isSerializingDerivedType?: boolean): void;
45
+ /**
46
+ * Serializes information the current object
47
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
48
+ * @param SummaryGetResponse The instance to serialize from.
49
+ * @param writer Serialization writer to use to serialize this model
50
+ */
51
+ export declare function serializeSummaryGetResponse(writer: SerializationWriter, summaryGetResponse?: Partial<SummaryGetResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
52
+ /**
53
+ * Serializes information the current object
54
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
55
+ * @param SummaryGetResponse_data The instance to serialize from.
56
+ * @param writer Serialization writer to use to serialize this model
57
+ */
58
+ export declare function serializeSummaryGetResponse_data(writer: SerializationWriter, summaryGetResponse_data?: Partial<SummaryGetResponse_data> | undefined | null, isSerializingDerivedType?: boolean): void;
59
+ export interface Summary403Error extends AdditionalDataHolder, ApiError, Parsable {
60
+ /**
61
+ * Stable machine-readable error code when available.
62
+ */
63
+ code?: string | null;
64
+ /**
65
+ * The error property
66
+ */
67
+ errorEscaped?: string | null;
68
+ /**
69
+ * The hint property
70
+ */
71
+ hint?: string | null;
72
+ /**
73
+ * The success property
74
+ */
75
+ success?: boolean | null;
76
+ }
77
+ export interface SummaryGetResponse extends AdditionalDataHolder, Parsable {
78
+ /**
79
+ * The data property
80
+ */
81
+ data?: SummaryGetResponse_data | null;
82
+ /**
83
+ * The success property
84
+ */
85
+ success?: boolean | null;
86
+ }
87
+ export interface SummaryGetResponse_data extends AdditionalDataHolder, Parsable {
88
+ /**
89
+ * The completedRecipients property
90
+ */
91
+ completedRecipients?: number | null;
92
+ /**
93
+ * The completedSigners property
94
+ */
95
+ completedSigners?: number | null;
96
+ /**
97
+ * The documents property
98
+ */
99
+ documents?: number | null;
100
+ /**
101
+ * The forms property
102
+ */
103
+ forms?: number | null;
104
+ }
105
+ /**
106
+ * Builds and executes requests for operations under /api/v1/analytics/summary
107
+ */
108
+ export interface SummaryRequestBuilder extends BaseRequestBuilder<SummaryRequestBuilder> {
109
+ /**
110
+ * Returns workspace totals for forms, documents, completed recipients, and completed signers. Requires the `analytics:read` permission.
111
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
112
+ * @returns {Promise<SummaryGetResponse>}
113
+ * @throws {Summary403Error} error when the service returns a 403 status code
114
+ */
115
+ get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<SummaryGetResponse | undefined>;
116
+ /**
117
+ * Returns workspace totals for forms, documents, completed recipients, and completed signers. Requires the `analytics:read` permission.
118
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
119
+ * @returns {RequestInformation}
120
+ */
121
+ toGetRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
122
+ }
123
+ /**
124
+ * Uri template for the request builder.
125
+ */
126
+ export declare const SummaryRequestBuilderUriTemplate = "{+baseurl}/api/v1/analytics/summary";
127
+ /**
128
+ * Metadata for all the requests in the request builder.
129
+ */
130
+ export declare const SummaryRequestBuilderRequestsMetadata: RequestsMetadata;
131
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/client/api/v1/analytics/summary/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,oBAAoB,EAAE,KAAK,QAAQ,EAAE,KAAK,kBAAkB,EAAE,KAAK,QAAQ,EAAwB,KAAK,SAAS,EAAE,KAAK,oBAAoB,EAAE,KAAK,kBAAkB,EAAE,KAAK,gBAAgB,EAAE,KAAK,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AAE5Q;;;;GAIG;AAEH,wBAAgB,2CAA2C,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,GAAI,CAAC,CAAC,QAAQ,CAAC,EAAE,QAAQ,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC,CAAC,CAEnK;AACD;;;;GAIG;AAEH,wBAAgB,mDAAmD,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,GAAI,CAAC,CAAC,QAAQ,CAAC,EAAE,QAAQ,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC,CAAC,CAE3K;AACD;;;;GAIG;AAEH,wBAAgB,8CAA8C,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,GAAI,CAAC,CAAC,QAAQ,CAAC,EAAE,QAAQ,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC,CAAC,CAEtK;AACD;;;;GAIG;AAEH,wBAAgB,8BAA8B,CAAC,eAAe,GAAE,OAAO,CAAC,eAAe,CAAC,GAAG,SAAc,GAAI,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC,CAOrJ;AACD;;;;GAIG;AAEH,wBAAgB,iCAAiC,CAAC,kBAAkB,GAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,SAAc,GAAI,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC,CAK9J;AACD;;;;GAIG;AAEH,wBAAgB,sCAAsC,CAAC,uBAAuB,GAAE,OAAO,CAAC,uBAAuB,CAAC,GAAG,SAAc,GAAI,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC,CAO7K;AACD;;;;;GAKG;AAEH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,mBAAmB,EAAE,eAAe,GAAE,OAAO,CAAC,eAAe,CAAC,GAAG,SAAS,GAAG,IAAS,EAAE,wBAAwB,GAAE,OAAe,GAAI,IAAI,CAOzL;AACD;;;;;GAKG;AAEH,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,mBAAmB,EAAE,kBAAkB,GAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,SAAS,GAAG,IAAS,EAAE,wBAAwB,GAAE,OAAe,GAAI,IAAI,CAKlM;AACD;;;;;GAKG;AAEH,wBAAgB,gCAAgC,CAAC,MAAM,EAAE,mBAAmB,EAAE,uBAAuB,GAAE,OAAO,CAAC,uBAAuB,CAAC,GAAG,SAAS,GAAG,IAAS,EAAE,wBAAwB,GAAE,OAAe,GAAI,IAAI,CAOjN;AACD,MAAM,WAAW,eAAgB,SAAQ,oBAAoB,EAAE,QAAQ,EAAE,QAAQ;IAC7E;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC5B;AACD,MAAM,WAAW,kBAAmB,SAAQ,oBAAoB,EAAE,QAAQ;IACtE;;OAEG;IACH,IAAI,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAC;IACtC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC5B;AACD,MAAM,WAAW,uBAAwB,SAAQ,oBAAoB,EAAE,QAAQ;IAC3E;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AACD;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,kBAAkB,CAAC,qBAAqB,CAAC;IACpF;;;;;OAKG;IACF,GAAG,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,MAAM,CAAC,GAAG,SAAS,GAAI,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC,CAAC;IAChH;;;;OAIG;IACF,uBAAuB,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,MAAM,CAAC,GAAG,SAAS,GAAI,kBAAkB,CAAC;CAClH;AACD;;GAEG;AACH,eAAO,MAAM,gCAAgC,wCAAwC,CAAC;AACtF;;GAEG;AACH,eAAO,MAAM,qCAAqC,EAAE,gBAUnD,CAAC"}
@@ -0,0 +1,137 @@
1
+ /**
2
+ * Creates a new instance of the appropriate class based on discriminator value
3
+ * @param parseNode The parse node to use to read the discriminator value and create the object
4
+ * @returns {Summary403Error}
5
+ */
6
+ // @ts-ignore
7
+ export function createSummary403ErrorFromDiscriminatorValue(parseNode) {
8
+ return deserializeIntoSummary403Error;
9
+ }
10
+ /**
11
+ * Creates a new instance of the appropriate class based on discriminator value
12
+ * @param parseNode The parse node to use to read the discriminator value and create the object
13
+ * @returns {SummaryGetResponse_data}
14
+ */
15
+ // @ts-ignore
16
+ export function createSummaryGetResponse_dataFromDiscriminatorValue(parseNode) {
17
+ return deserializeIntoSummaryGetResponse_data;
18
+ }
19
+ /**
20
+ * Creates a new instance of the appropriate class based on discriminator value
21
+ * @param parseNode The parse node to use to read the discriminator value and create the object
22
+ * @returns {SummaryGetResponse}
23
+ */
24
+ // @ts-ignore
25
+ export function createSummaryGetResponseFromDiscriminatorValue(parseNode) {
26
+ return deserializeIntoSummaryGetResponse;
27
+ }
28
+ /**
29
+ * The deserialization information for the current model
30
+ * @param Summary403Error The instance to deserialize into.
31
+ * @returns {Record<string, (node: ParseNode) => void>}
32
+ */
33
+ // @ts-ignore
34
+ export function deserializeIntoSummary403Error(summary403Error = {}) {
35
+ return {
36
+ "code": n => { summary403Error.code = n.getStringValue(); },
37
+ "error": n => { summary403Error.errorEscaped = n.getStringValue(); },
38
+ "hint": n => { summary403Error.hint = n.getStringValue(); },
39
+ "success": n => { summary403Error.success = n.getBooleanValue(); },
40
+ };
41
+ }
42
+ /**
43
+ * The deserialization information for the current model
44
+ * @param SummaryGetResponse The instance to deserialize into.
45
+ * @returns {Record<string, (node: ParseNode) => void>}
46
+ */
47
+ // @ts-ignore
48
+ export function deserializeIntoSummaryGetResponse(summaryGetResponse = {}) {
49
+ return {
50
+ "data": n => { summaryGetResponse.data = n.getObjectValue(createSummaryGetResponse_dataFromDiscriminatorValue); },
51
+ "success": n => { summaryGetResponse.success = n.getBooleanValue(); },
52
+ };
53
+ }
54
+ /**
55
+ * The deserialization information for the current model
56
+ * @param SummaryGetResponse_data The instance to deserialize into.
57
+ * @returns {Record<string, (node: ParseNode) => void>}
58
+ */
59
+ // @ts-ignore
60
+ export function deserializeIntoSummaryGetResponse_data(summaryGetResponse_data = {}) {
61
+ return {
62
+ "completedRecipients": n => { summaryGetResponse_data.completedRecipients = n.getNumberValue(); },
63
+ "completedSigners": n => { summaryGetResponse_data.completedSigners = n.getNumberValue(); },
64
+ "documents": n => { summaryGetResponse_data.documents = n.getNumberValue(); },
65
+ "forms": n => { summaryGetResponse_data.forms = n.getNumberValue(); },
66
+ };
67
+ }
68
+ /**
69
+ * Serializes information the current object
70
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
71
+ * @param Summary403Error The instance to serialize from.
72
+ * @param writer Serialization writer to use to serialize this model
73
+ */
74
+ // @ts-ignore
75
+ export function serializeSummary403Error(writer, summary403Error = {}, isSerializingDerivedType = false) {
76
+ if (!summary403Error || isSerializingDerivedType) {
77
+ return;
78
+ }
79
+ writer.writeStringValue("code", summary403Error.code);
80
+ writer.writeStringValue("error", summary403Error.errorEscaped);
81
+ writer.writeStringValue("hint", summary403Error.hint);
82
+ writer.writeBooleanValue("success", summary403Error.success);
83
+ writer.writeAdditionalData(summary403Error.additionalData);
84
+ }
85
+ /**
86
+ * Serializes information the current object
87
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
88
+ * @param SummaryGetResponse The instance to serialize from.
89
+ * @param writer Serialization writer to use to serialize this model
90
+ */
91
+ // @ts-ignore
92
+ export function serializeSummaryGetResponse(writer, summaryGetResponse = {}, isSerializingDerivedType = false) {
93
+ if (!summaryGetResponse || isSerializingDerivedType) {
94
+ return;
95
+ }
96
+ writer.writeObjectValue("data", summaryGetResponse.data, serializeSummaryGetResponse_data);
97
+ writer.writeBooleanValue("success", summaryGetResponse.success);
98
+ writer.writeAdditionalData(summaryGetResponse.additionalData);
99
+ }
100
+ /**
101
+ * Serializes information the current object
102
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
103
+ * @param SummaryGetResponse_data The instance to serialize from.
104
+ * @param writer Serialization writer to use to serialize this model
105
+ */
106
+ // @ts-ignore
107
+ export function serializeSummaryGetResponse_data(writer, summaryGetResponse_data = {}, isSerializingDerivedType = false) {
108
+ if (!summaryGetResponse_data || isSerializingDerivedType) {
109
+ return;
110
+ }
111
+ writer.writeNumberValue("completedRecipients", summaryGetResponse_data.completedRecipients);
112
+ writer.writeNumberValue("completedSigners", summaryGetResponse_data.completedSigners);
113
+ writer.writeNumberValue("documents", summaryGetResponse_data.documents);
114
+ writer.writeNumberValue("forms", summaryGetResponse_data.forms);
115
+ writer.writeAdditionalData(summaryGetResponse_data.additionalData);
116
+ }
117
+ /**
118
+ * Uri template for the request builder.
119
+ */
120
+ export const SummaryRequestBuilderUriTemplate = "{+baseurl}/api/v1/analytics/summary";
121
+ /**
122
+ * Metadata for all the requests in the request builder.
123
+ */
124
+ export const SummaryRequestBuilderRequestsMetadata = {
125
+ get: {
126
+ uriTemplate: SummaryRequestBuilderUriTemplate,
127
+ responseBodyContentType: "application/json",
128
+ errorMappings: {
129
+ 403: createSummary403ErrorFromDiscriminatorValue,
130
+ },
131
+ adapterMethodName: "send",
132
+ responseBodyFactory: createSummaryGetResponseFromDiscriminatorValue,
133
+ },
134
+ };
135
+ /* tslint:enable */
136
+ /* eslint-enable */
137
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../src/client/api/v1/analytics/summary/index.ts"],"names":[],"mappings":"AAMA;;;;GAIG;AACH,aAAa;AACb,MAAM,UAAU,2CAA2C,CAAC,SAAgC;IACxF,OAAO,8BAA8B,CAAC;AAC1C,CAAC;AACD;;;;GAIG;AACH,aAAa;AACb,MAAM,UAAU,mDAAmD,CAAC,SAAgC;IAChG,OAAO,sCAAsC,CAAC;AAClD,CAAC;AACD;;;;GAIG;AACH,aAAa;AACb,MAAM,UAAU,8CAA8C,CAAC,SAAgC;IAC3F,OAAO,iCAAiC,CAAC;AAC7C,CAAC;AACD;;;;GAIG;AACH,aAAa;AACb,MAAM,UAAU,8BAA8B,CAAC,kBAAwD,EAAE;IACrG,OAAO;QACH,MAAM,EAAE,CAAC,CAAC,EAAE,GAAG,eAAe,CAAC,IAAI,GAAG,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;QAC3D,OAAO,EAAE,CAAC,CAAC,EAAE,GAAG,eAAe,CAAC,YAAY,GAAG,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;QACpE,MAAM,EAAE,CAAC,CAAC,EAAE,GAAG,eAAe,CAAC,IAAI,GAAG,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;QAC3D,SAAS,EAAE,CAAC,CAAC,EAAE,GAAG,eAAe,CAAC,OAAO,GAAG,CAAC,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;KACrE,CAAA;AACL,CAAC;AACD;;;;GAIG;AACH,aAAa;AACb,MAAM,UAAU,iCAAiC,CAAC,qBAA8D,EAAE;IAC9G,OAAO;QACH,MAAM,EAAE,CAAC,CAAC,EAAE,GAAG,kBAAkB,CAAC,IAAI,GAAG,CAAC,CAAC,cAAc,CAA0B,mDAAmD,CAAC,CAAC,CAAC,CAAC;QAC1I,SAAS,EAAE,CAAC,CAAC,EAAE,GAAG,kBAAkB,CAAC,OAAO,GAAG,CAAC,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;KACxE,CAAA;AACL,CAAC;AACD;;;;GAIG;AACH,aAAa;AACb,MAAM,UAAU,sCAAsC,CAAC,0BAAwE,EAAE;IAC7H,OAAO;QACH,qBAAqB,EAAE,CAAC,CAAC,EAAE,GAAG,uBAAuB,CAAC,mBAAmB,GAAG,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;QACjG,kBAAkB,EAAE,CAAC,CAAC,EAAE,GAAG,uBAAuB,CAAC,gBAAgB,GAAG,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;QAC3F,WAAW,EAAE,CAAC,CAAC,EAAE,GAAG,uBAAuB,CAAC,SAAS,GAAG,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;QAC7E,OAAO,EAAE,CAAC,CAAC,EAAE,GAAG,uBAAuB,CAAC,KAAK,GAAG,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;KACxE,CAAA;AACL,CAAC;AACD;;;;;GAKG;AACH,aAAa;AACb,MAAM,UAAU,wBAAwB,CAAC,MAA2B,EAAE,kBAA+D,EAAE,EAAE,2BAAoC,KAAK;IAC9K,IAAI,CAAC,eAAe,IAAI,wBAAwB,EAAE,CAAC;QAAC,OAAO;IAAC,CAAC;IAC7D,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,eAAe,CAAC,IAAI,CAAC,CAAC;IACtD,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,eAAe,CAAC,YAAY,CAAC,CAAC;IAC/D,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,eAAe,CAAC,IAAI,CAAC,CAAC;IACtD,MAAM,CAAC,iBAAiB,CAAC,SAAS,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC;IAC7D,MAAM,CAAC,mBAAmB,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;AAC/D,CAAC;AACD;;;;;GAKG;AACH,aAAa;AACb,MAAM,UAAU,2BAA2B,CAAC,MAA2B,EAAE,qBAAqE,EAAE,EAAE,2BAAoC,KAAK;IACvL,IAAI,CAAC,kBAAkB,IAAI,wBAAwB,EAAE,CAAC;QAAC,OAAO;IAAC,CAAC;IAChE,MAAM,CAAC,gBAAgB,CAA0B,MAAM,EAAE,kBAAkB,CAAC,IAAI,EAAE,gCAAgC,CAAC,CAAC;IACpH,MAAM,CAAC,iBAAiB,CAAC,SAAS,EAAE,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAChE,MAAM,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAC;AAClE,CAAC;AACD;;;;;GAKG;AACH,aAAa;AACb,MAAM,UAAU,gCAAgC,CAAC,MAA2B,EAAE,0BAA+E,EAAE,EAAE,2BAAoC,KAAK;IACtM,IAAI,CAAC,uBAAuB,IAAI,wBAAwB,EAAE,CAAC;QAAC,OAAO;IAAC,CAAC;IACrE,MAAM,CAAC,gBAAgB,CAAC,qBAAqB,EAAE,uBAAuB,CAAC,mBAAmB,CAAC,CAAC;IAC5F,MAAM,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,uBAAuB,CAAC,gBAAgB,CAAC,CAAC;IACtF,MAAM,CAAC,gBAAgB,CAAC,WAAW,EAAE,uBAAuB,CAAC,SAAS,CAAC,CAAC;IACxE,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,CAAC,KAAK,CAAC,CAAC;IAChE,MAAM,CAAC,mBAAmB,CAAC,uBAAuB,CAAC,cAAc,CAAC,CAAC;AACvE,CAAC;AAiED;;GAEG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,qCAAqC,CAAC;AACtF;;GAEG;AACH,MAAM,CAAC,MAAM,qCAAqC,GAAqB;IACnE,GAAG,EAAE;QACD,WAAW,EAAE,gCAAgC;QAC7C,uBAAuB,EAAE,kBAAkB;QAC3C,aAAa,EAAE;YACX,GAAG,EAAE,2CAAwE;SAChF;QACD,iBAAiB,EAAE,MAAM;QACzB,mBAAmB,EAAG,8CAA8C;KACvE;CACJ,CAAC;AACF,mBAAmB;AACnB,mBAAmB"}
@@ -0,0 +1,192 @@
1
+ import { type AdditionalDataHolder, type ApiError, type BaseRequestBuilder, type Guid, type Parsable, type ParseNode, type RequestConfiguration, type RequestInformation, type RequestsMetadata, type SerializationWriter } from '@microsoft/kiota-abstractions';
2
+ /**
3
+ * Creates a new instance of the appropriate class based on discriminator value
4
+ * @param parseNode The parse node to use to read the discriminator value and create the object
5
+ * @returns {Deliveries403Error}
6
+ */
7
+ export declare function createDeliveries403ErrorFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
8
+ /**
9
+ * Creates a new instance of the appropriate class based on discriminator value
10
+ * @param parseNode The parse node to use to read the discriminator value and create the object
11
+ * @returns {DeliveriesGetResponse_data_profile}
12
+ */
13
+ export declare function createDeliveriesGetResponse_data_profileFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
14
+ /**
15
+ * Creates a new instance of the appropriate class based on discriminator value
16
+ * @param parseNode The parse node to use to read the discriminator value and create the object
17
+ * @returns {DeliveriesGetResponse_data}
18
+ */
19
+ export declare function createDeliveriesGetResponse_dataFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
20
+ /**
21
+ * Creates a new instance of the appropriate class based on discriminator value
22
+ * @param parseNode The parse node to use to read the discriminator value and create the object
23
+ * @returns {DeliveriesGetResponse}
24
+ */
25
+ export declare function createDeliveriesGetResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
26
+ export interface Deliveries403Error extends AdditionalDataHolder, ApiError, Parsable {
27
+ /**
28
+ * Stable machine-readable error code when available.
29
+ */
30
+ code?: string | null;
31
+ /**
32
+ * The error property
33
+ */
34
+ errorEscaped?: string | null;
35
+ /**
36
+ * The hint property
37
+ */
38
+ hint?: string | null;
39
+ /**
40
+ * The success property
41
+ */
42
+ success?: boolean | null;
43
+ }
44
+ export interface DeliveriesGetResponse extends AdditionalDataHolder, Parsable {
45
+ /**
46
+ * The data property
47
+ */
48
+ data?: DeliveriesGetResponse_data[] | null;
49
+ /**
50
+ * The success property
51
+ */
52
+ success?: boolean | null;
53
+ }
54
+ export interface DeliveriesGetResponse_data extends AdditionalDataHolder, Parsable {
55
+ /**
56
+ * The attemptedAt property
57
+ */
58
+ attemptedAt?: Date | null;
59
+ /**
60
+ * The blockedReason property
61
+ */
62
+ blockedReason?: string | null;
63
+ /**
64
+ * The channel property
65
+ */
66
+ channel?: string | null;
67
+ /**
68
+ * The eventType property
69
+ */
70
+ eventType?: string | null;
71
+ /**
72
+ * The id property
73
+ */
74
+ id?: Guid | null;
75
+ /**
76
+ * The profile property
77
+ */
78
+ profile?: DeliveriesGetResponse_data_profile | null;
79
+ /**
80
+ * The providerStatus property
81
+ */
82
+ providerStatus?: string | null;
83
+ /**
84
+ * The requestAccepted property
85
+ */
86
+ requestAccepted?: boolean | null;
87
+ /**
88
+ * The state property
89
+ */
90
+ state?: string | null;
91
+ /**
92
+ * The statusCode property
93
+ */
94
+ statusCode?: number | null;
95
+ /**
96
+ * For email and WhatsApp, whether the provider accepted the request. This does not establish inbox delivery; inspect state and providerStatus.
97
+ */
98
+ success?: boolean | null;
99
+ }
100
+ export interface DeliveriesGetResponse_data_profile extends AdditionalDataHolder, Parsable {
101
+ /**
102
+ * The id property
103
+ */
104
+ id?: Guid | null;
105
+ /**
106
+ * The label property
107
+ */
108
+ label?: string | null;
109
+ /**
110
+ * The typeSlug property
111
+ */
112
+ typeSlug?: string | null;
113
+ }
114
+ /**
115
+ * Builds and executes requests for operations under /api/v1/deliveries
116
+ */
117
+ export interface DeliveriesRequestBuilder extends BaseRequestBuilder<DeliveriesRequestBuilder> {
118
+ /**
119
+ * Returns the 50 most recent integration delivery attempts for the workspace. Requires the `deliveries:read` permission.
120
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
121
+ * @returns {Promise<DeliveriesGetResponse>}
122
+ * @throws {Deliveries403Error} error when the service returns a 403 status code
123
+ */
124
+ get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<DeliveriesGetResponse | undefined>;
125
+ /**
126
+ * Returns the 50 most recent integration delivery attempts for the workspace. Requires the `deliveries:read` permission.
127
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
128
+ * @returns {RequestInformation}
129
+ */
130
+ toGetRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
131
+ }
132
+ /**
133
+ * The deserialization information for the current model
134
+ * @param Deliveries403Error The instance to deserialize into.
135
+ * @returns {Record<string, (node: ParseNode) => void>}
136
+ */
137
+ export declare function deserializeIntoDeliveries403Error(deliveries403Error?: Partial<Deliveries403Error> | undefined): Record<string, (node: ParseNode) => void>;
138
+ /**
139
+ * The deserialization information for the current model
140
+ * @param DeliveriesGetResponse The instance to deserialize into.
141
+ * @returns {Record<string, (node: ParseNode) => void>}
142
+ */
143
+ export declare function deserializeIntoDeliveriesGetResponse(deliveriesGetResponse?: Partial<DeliveriesGetResponse> | undefined): Record<string, (node: ParseNode) => void>;
144
+ /**
145
+ * The deserialization information for the current model
146
+ * @param DeliveriesGetResponse_data The instance to deserialize into.
147
+ * @returns {Record<string, (node: ParseNode) => void>}
148
+ */
149
+ export declare function deserializeIntoDeliveriesGetResponse_data(deliveriesGetResponse_data?: Partial<DeliveriesGetResponse_data> | undefined): Record<string, (node: ParseNode) => void>;
150
+ /**
151
+ * The deserialization information for the current model
152
+ * @param DeliveriesGetResponse_data_profile The instance to deserialize into.
153
+ * @returns {Record<string, (node: ParseNode) => void>}
154
+ */
155
+ export declare function deserializeIntoDeliveriesGetResponse_data_profile(deliveriesGetResponse_data_profile?: Partial<DeliveriesGetResponse_data_profile> | undefined): Record<string, (node: ParseNode) => void>;
156
+ /**
157
+ * Serializes information the current object
158
+ * @param Deliveries403Error The instance to serialize from.
159
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
160
+ * @param writer Serialization writer to use to serialize this model
161
+ */
162
+ export declare function serializeDeliveries403Error(writer: SerializationWriter, deliveries403Error?: Partial<Deliveries403Error> | undefined | null, isSerializingDerivedType?: boolean): void;
163
+ /**
164
+ * Serializes information the current object
165
+ * @param DeliveriesGetResponse The instance to serialize from.
166
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
167
+ * @param writer Serialization writer to use to serialize this model
168
+ */
169
+ export declare function serializeDeliveriesGetResponse(writer: SerializationWriter, deliveriesGetResponse?: Partial<DeliveriesGetResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
170
+ /**
171
+ * Serializes information the current object
172
+ * @param DeliveriesGetResponse_data The instance to serialize from.
173
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
174
+ * @param writer Serialization writer to use to serialize this model
175
+ */
176
+ export declare function serializeDeliveriesGetResponse_data(writer: SerializationWriter, deliveriesGetResponse_data?: Partial<DeliveriesGetResponse_data> | undefined | null, isSerializingDerivedType?: boolean): void;
177
+ /**
178
+ * Serializes information the current object
179
+ * @param DeliveriesGetResponse_data_profile The instance to serialize from.
180
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
181
+ * @param writer Serialization writer to use to serialize this model
182
+ */
183
+ export declare function serializeDeliveriesGetResponse_data_profile(writer: SerializationWriter, deliveriesGetResponse_data_profile?: Partial<DeliveriesGetResponse_data_profile> | undefined | null, isSerializingDerivedType?: boolean): void;
184
+ /**
185
+ * Uri template for the request builder.
186
+ */
187
+ export declare const DeliveriesRequestBuilderUriTemplate = "{+baseurl}/api/v1/deliveries";
188
+ /**
189
+ * Metadata for all the requests in the request builder.
190
+ */
191
+ export declare const DeliveriesRequestBuilderRequestsMetadata: RequestsMetadata;
192
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/client/api/v1/deliveries/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,oBAAoB,EAAE,KAAK,QAAQ,EAAE,KAAK,kBAAkB,EAAE,KAAK,IAAI,EAAE,KAAK,QAAQ,EAAwB,KAAK,SAAS,EAAE,KAAK,oBAAoB,EAAE,KAAK,kBAAkB,EAAE,KAAK,gBAAgB,EAAE,KAAK,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AAEvR;;;;GAIG;AAEH,wBAAgB,8CAA8C,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,GAAI,CAAC,CAAC,QAAQ,CAAC,EAAE,QAAQ,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC,CAAC,CAEtK;AACD;;;;GAIG;AAEH,wBAAgB,8DAA8D,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,GAAI,CAAC,CAAC,QAAQ,CAAC,EAAE,QAAQ,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC,CAAC,CAEtL;AACD;;;;GAIG;AAEH,wBAAgB,sDAAsD,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,GAAI,CAAC,CAAC,QAAQ,CAAC,EAAE,QAAQ,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC,CAAC,CAE9K;AACD;;;;GAIG;AAEH,wBAAgB,iDAAiD,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,GAAI,CAAC,CAAC,QAAQ,CAAC,EAAE,QAAQ,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC,CAAC,CAEzK;AACD,MAAM,WAAW,kBAAmB,SAAQ,oBAAoB,EAAE,QAAQ,EAAE,QAAQ;IAChF;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC5B;AACD,MAAM,WAAW,qBAAsB,SAAQ,oBAAoB,EAAE,QAAQ;IACzE;;OAEG;IACH,IAAI,CAAC,EAAE,0BAA0B,EAAE,GAAG,IAAI,CAAC;IAC3C;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC5B;AACD,MAAM,WAAW,0BAA2B,SAAQ,oBAAoB,EAAE,QAAQ;IAC9E;;OAEG;IACH,WAAW,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IAC1B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B;;OAEG;IACH,EAAE,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,kCAAkC,GAAG,IAAI,CAAC;IACpD;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC5B;AACD,MAAM,WAAW,kCAAmC,SAAQ,oBAAoB,EAAE,QAAQ;IACtF;;OAEG;IACH,EAAE,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AACD;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,kBAAkB,CAAC,wBAAwB,CAAC;IAC1F;;;;;OAKG;IACF,GAAG,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,MAAM,CAAC,GAAG,SAAS,GAAI,OAAO,CAAC,qBAAqB,GAAG,SAAS,CAAC,CAAC;IACnH;;;;OAIG;IACF,uBAAuB,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,MAAM,CAAC,GAAG,SAAS,GAAI,kBAAkB,CAAC;CAClH;AACD;;;;GAIG;AAEH,wBAAgB,iCAAiC,CAAC,kBAAkB,GAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,SAAc,GAAI,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC,CAO9J;AACD;;;;GAIG;AAEH,wBAAgB,oCAAoC,CAAC,qBAAqB,GAAE,OAAO,CAAC,qBAAqB,CAAC,GAAG,SAAc,GAAI,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC,CAKvK;AACD;;;;GAIG;AAEH,wBAAgB,yCAAyC,CAAC,0BAA0B,GAAE,OAAO,CAAC,0BAA0B,CAAC,GAAG,SAAc,GAAI,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC,CActL;AACD;;;;GAIG;AAEH,wBAAgB,iDAAiD,CAAC,kCAAkC,GAAE,OAAO,CAAC,kCAAkC,CAAC,GAAG,SAAc,GAAI,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC,CAM9M;AACD;;;;;GAKG;AAEH,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,mBAAmB,EAAE,kBAAkB,GAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,SAAS,GAAG,IAAS,EAAE,wBAAwB,GAAE,OAAe,GAAI,IAAI,CAOlM;AACD;;;;;GAKG;AAEH,wBAAgB,8BAA8B,CAAC,MAAM,EAAE,mBAAmB,EAAE,qBAAqB,GAAE,OAAO,CAAC,qBAAqB,CAAC,GAAG,SAAS,GAAG,IAAS,EAAE,wBAAwB,GAAE,OAAe,GAAI,IAAI,CAK3M;AACD;;;;;GAKG;AAEH,wBAAgB,mCAAmC,CAAC,MAAM,EAAE,mBAAmB,EAAE,0BAA0B,GAAE,OAAO,CAAC,0BAA0B,CAAC,GAAG,SAAS,GAAG,IAAS,EAAE,wBAAwB,GAAE,OAAe,GAAI,IAAI,CAc1N;AACD;;;;;GAKG;AAEH,wBAAgB,2CAA2C,CAAC,MAAM,EAAE,mBAAmB,EAAE,kCAAkC,GAAE,OAAO,CAAC,kCAAkC,CAAC,GAAG,SAAS,GAAG,IAAS,EAAE,wBAAwB,GAAE,OAAe,GAAI,IAAI,CAMlP;AACD;;GAEG;AACH,eAAO,MAAM,mCAAmC,iCAAiC,CAAC;AAClF;;GAEG;AACH,eAAO,MAAM,wCAAwC,EAAE,gBAUtD,CAAC"}